Certyneo (Pré-visualização)

Envie documentos para assinatura eletrónica compatível com eIDAS, crie envelopes a partir de modelos e acione fluxos em eventos de assinatura como enviados, assinados, concluídos e recusados.

Este conector está disponível nos seguintes produtos e regiões:

Serviço Class Regions
Estúdio Copiloto Premium Todas as regiões Power Automate exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões Power Apps exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões Power Automate exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Entrar em contato
Name Suporte Certyneo
URL https://certyneo.com/fr/contact
Email support@certyneo.com
Metadados do conector
Publisher Certyneo
Sítio Web https://certyneo.com
Política de privacidade https://certyneo.com/fr/legal/privacy
Categorias Operações de TI; Produtividade

Certyneo

A Certyneo é um serviço de assinatura eletrónica compatível com eIDAS. Este conector permite que um fluxo envie documentos para assinatura, reaja em tempo real quando um signatário atua, e arquive o PDF assinado e o seu ficheiro de provas onde quer que o resto da empresa guarde os seus registos.

O fluxo típico é composto por três passos: um documento aterra em algum lugar (uma biblioteca de documentos, uma caixa de correio, uma submissão de formulário), o fluxo cria e envia um envelope, e um segundo fluxo desencadeado pelo envelope.completed download do PDF assinado e armazena-o.

Publisher

Certyneo

Prerequisites

Precisas de uma conta Certyneo num plano que inclua acesso à API. Os planos gratuitos e pessoais podem criar chaves API e subscrever eventos, mas só recebem eventos para envelopes sandbox — ver Problemas conhecidos e limitações abaixo.

Como obter credenciais

O conector autentica-se com uma chave API Certyneo.

  1. Inicia sessão no Certyneo e abre as Definições → Chaves API.
  2. Cria uma chave. As chaves vivas começam com sk_live_, chaves sandbox com sk_test_.
  3. Quando o conector pedir a chave API, cole a palavra Bearer, um espaço e depois a chave — por exemplo Bearer sk_live_abc123, . A Certyneo espera a palavra Bearer à frente da chave, e uma chave colada sozinha é rejeitada com a 401.

A chave transporta miras. Uma chave sem envelopes:write não pode criar ou enviar, e uma chave sem webhooks:write não pode reverter o gatilho. Conceda os endoscópios que o fluxo realmente precisa.

Testar sem enviar email a ninguém

Uma chave sandbox (sk_test_) exerce todo o pipeline sem enviar um único e-mail de convite. Nada chega a uma caixa de entrada real, o que também significa que ninguém pode aceder à página de assinatura a partir de um email — por isso , Criar envelope e enviar envelope devolve um token de acesso para cada destinatário. Aberto https://certyneo.com/sign/<access token> para assinar o envelope do teste você mesmo.

Trate esse token como uma credencial: qualquer pessoa que o tenha pode assinar como destinatário. Não registas, nem coloques numa folha de cálculo.

Operações suportadas

Trigger

Quando ocorre um evento envelope — dispara sobre os eventos que seleciona, apoiado por um webhook real em vez de uma sondagem. Eventos disponíveis:

envelope.created, envelope.sent, envelope.declinedenvelope.completed, envelope.voided, , envelope.expired, recipient.viewedenvelope.returned_to_senderenvelope.resubmittedrecipient.signed. recipient.approved

Cada carga útil transporta o ID do envelope, tanto no envelope como no evento do destinatário. Esse é o valor a alimentar nas ações abaixo.

As entregas são assinadas com HMAC-SHA256 no X-Certyneo-Signature cabeçalho — um resumo hexadecimal do corpo JSON bruto, indexado pelo segredo da subscrição. Verifica antes que um fluxo atue sobre a carga útil.

Actions

Ação O que faz
Modelos de lista Os teus modelos de envelopes guardados. Alimenta o seletor de templates.
Criar envelope Cria um envelope RASCUNHO, a partir de um modelo ou de documentos carregados.
Enviar envelope Envia um envelope de DRAFT aos seus destinatários.
Recebe o envelope Estado atual e detalhes do destinatário.
Listar envelopes Lista paginada, filtrável por estado.
Carregar documento Carrega um PDF ou imagem e devolve um ID de documento.
Descarregar documento assinado O PDF assinado, incluindo a página do certificado.
Descarregar o trilho de auditoria O ficheiro de provas: quem assinou, quando, de que propriedade intelectual, com que fatores.
Eliminar envelope de rascunho Apaga um envelope que nunca foi enviado.

Problemas e limitações conhecidos

Um envelope enviado não pode ser recuperado de um fluxo.O envelope Delete Draft só aceita envelopes ainda em DRAFT — um fluxo que falhou a meio, um documento errado. Assim que um envelope é enviado, devolve o 409, e hoje não há operação de cancelamento na API.

recipient.signed fogo antes de existir o PDF assinado, incluindo para o último signatário. A montagem e selagem do documento final acontece depois desse evento, por isso um fluxo que é ativado recipient.signed e imediatamente liga para Descarregar documento assinado recebe o 409 sempre. Esta não é uma corrida que se pode ganhar com um delay — é envelope.completed ativado em vez disso, que dispara assim que o PDF está no disco.

Os planos gratuitos e pessoais recebem apenas eventos sandbox. Ambos podem criar uma subscrição e o gatilho aparecerá como saudável, mas os envelopes ao vivo nunca chegam até lá. Se um gatilho parecer não fazer efeito no tráfego real, verifique o plano antes de qualquer outra coisa.

Use um modelo ou documentos, nunca ambos. Um modelo traz os seus próprios documentos e os seus próprios campos de assinatura. Quando constrói a partir de documentos carregados, também tem de fornecer Fields — um envelope cujo signatário não tem onde assinar é recusado no momento de envio com 409 signer_without_field, não no momento de criação.

Prefiro texto âncora a coordenadas. Colocar um campo citando uma frase do documento ("Signature du client") sobrevive a uma alteração de layout e não precisa de medição. X e Y permanecem como recurso, de modo que um campo cuja âncora não é encontrada mantém uma posição literal em vez de desaparecer.

Os carregamentos são limitados a 50 MB por documento.

Um documento purgado devolve 410, não 409. 409 significa "ainda não pronto, volta depois envelope.completed". 410 significa que o documento assinado foi deliberadamente apagado ao abrigo da política de retenção e nunca mais vai voltar. Um loop de retentativa deve desistir no 410.

Erros e soluções comuns

Resposta Cause Solução
401 Chave em falta, ou colada sem Bearer a frente Reintroduza a ligação como Bearer sk_live_...
403 A chave não tem o âmbito para esta operação Reemita a chave com os escopetos necessários ao fluxo
409 em download O envelope ainda não está CONCLUÍDO Gatilho ligado envelope.completed em vez de sondagem
409 em envio signer_without_field — um signatário não tem campo de assinatura Adicionar Campos, ou construir a partir de um template
409 na eliminação O envelope já foi enviado Envelopes enviados não podem ser eliminados ou recolhidos
410 em download O documento foi purgado ao abrigo da política de retenção Pára de tentar outra vez; o ficheiro desapareceu

Os erros transportam tanto uma mensagem legível error por humanos como um .code Branch on code — a mensagem pode ser reformulada.

Support

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:

Default Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: Todas as regiões

Parâmetros para criar conexão.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Name Tipo Description Required
Chave de API securestring A chave de API para esta api Verdade

Ações

Carregar documento

Carregue um PDF ou imagem (máximo 50 MB). Devolve um ID de documento — passa-o para "Criar envelope" em "Documentos".

Criar envelope

Crie um novo envelope em estado RASCUNHO, seja a partir de um modelo guardado ou diretamente de documentos que carregou com "Carregar documento". Preencha exatamente um dos "Modelos" ou "Documentos". Nos documentos, adicione também "Campos" para que cada signatário tenha um local para assinar — a forma mais simples é citar uma frase do documento em "Texto âncora" em vez de calcular coordenadas. IMPORTANTE: esta ação cria apenas o envelope — ainda não foi enviado nenhum email. Adiciona a ação "Enviar envelope" logo a seguir a este no teu fluxo para realmente o enviar aos destinatários.

Descarregar documento assinado

Obtenha o PDF assinado, incluindo a página do certificado. Só depois de o envelope estar CONCLUÍDO — antes disso, devolve 409, por isso é ativado no "Envelope concluído" em vez de no sondamento.

Descarregar o trilho de auditoria

Obtenha o ficheiro de provas de um envelope preenchido — quem assinou, quando, de que IP, com que fatores de autenticação. Arquiva-o juntamente com o PDF assinado: é o que uma disputa de eIDAS desencadeia.

Eliminar envelope de rascunho

Apagar um envelope que nunca foi enviado — um fluxo que falhou a meio, um documento errado. Apenas DRAFT: uma vez que um envelope é enviado, este devolve um erro e não consegue recuperá-lo de um fluxo.

Enviar envelope

Envie um envelope RASCUNHO aos destinatários para assinatura — este é o passo que realmente envia o email. "Criar envelope" só o guarda como rascunho; não envia nada por si só. Encadeia sempre esta ação logo após "Criar envelope" no teu fluxo, usando o ID do envelope que devolveu.

Listar envelopes

Recupere uma lista paginada de envelopes.

Modelos de lista

Devolve os teus modelos de envelopes guardados. Usado para alimentar o seletor de modelos em "Criar envelope".

Recebe o envelope

Obtenha o estado atual e os detalhes de um envelope.

Carregar documento

Carregue um PDF ou imagem (máximo 50 MB). Devolve um ID de documento — passa-o para "Criar envelope" em "Documentos".

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Ficheiro
file True file

O PDF ou imagem para carregar, 50 MB no máximo.

Nome do documento
name string

Nome para arquivar o documento. Por defeito, o nome do ficheiro carregado por defeito.

Devoluções

Body
Document

Criar envelope

Crie um novo envelope em estado RASCUNHO, seja a partir de um modelo guardado ou diretamente de documentos que carregou com "Carregar documento". Preencha exatamente um dos "Modelos" ou "Documentos". Nos documentos, adicione também "Campos" para que cada signatário tenha um local para assinar — a forma mais simples é citar uma frase do documento em "Texto âncora" em vez de calcular coordenadas. IMPORTANTE: esta ação cria apenas o envelope — ainda não foi enviado nenhum email. Adiciona a ação "Enviar envelope" logo a seguir a este no teu fluxo para realmente o enviar aos destinatários.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Subject
subject True string

Assunto / título do envelope.

Message
message string

Mensagem mostrada aos destinatários.

Template
templateId string

Escolhe um modelo guardado. Use este OU "Documentos", não ambos — um modelo traz os seus próprios documentos e campos de assinatura.

Documents
documentIds array of string

IDs de documentos a partir de "Carregar documento". Usa este "Modelo" OU, não ambos. Quando usar documentos, adicione também "Campos" — um envelope cujo signatário não tem campo de assinatura é recusado no momento do envio.

E-mail do signatário
recipientEmail True string

Tem de corresponder exatamente a um dos destinatários acima.

Número do documento
documentIndex integer

Qual documento contém este campo, contando a partir de 0 na ordem dada acima. Deixe vazio quando só houver um documento.

Página
pageNumber True integer
Tipo de campo
fieldType True string
Texto âncora (recomendado)
anchorText string

Texto a procurar no documento — o campo está colocado ao lado, por isso não precisa de coordenadas. Insensível a maiúsculas minúsculas, e encontra-se mesmo quando o PDF divide a frase em runs. Deixe vazio para usar X/Y em vez disso.

Colocação da âncora
anchorPlacement string

Onde colocar o campo em relação ao texto âncora.

Ocorrência âncora
anchorIndex integer

Que ocorrência usar, contando a partir de 0, quando o texto âncora aparece várias vezes.

X
x True number

Aponta a partir da borda esquerda. Ignorado quando a âncora é encontrada — mantido como plano B para que o campo nunca desapareça.

Y
y True number

Pontos a partir da BORDA SUPERIOR. Ignorado quando a âncora é encontrada — guardado como plano B.

Largura
width True number
Altura
height True number
E-mail do destinatário
email True string
Nome do destinatário
name string
Função
role string
estado
status string
assinadoEm
signedAt string
Token de acesso
accessToken string

Abre a página de assinatura deste destinatário em https://certyneo.com/sign/<token>. No sandbox, nenhum email de convite é enviado, por isso é assim que assinas um envelope de teste tu próprio. Devolvido por "Criar envelope" e "Enviar envelope" — não por "Receber envelope", onde fica vazio. Trate-o como uma credencial: qualquer pessoa que a tenha pode assinar como destinatário, por isso não a registre nem coloque numa folha de cálculo.

Nível de assinatura
signatureLevel string
Expira a
expiresAt date-time
Categoria
category string

Classificação empresarial mostrada na lista de envelopes. Deixa vazio e Certyneo deduz um do sujeito.

Etiquetas
tags array of string

Etiquetas de formato livre — código do projeto, referência do cliente, estado interno. Até 10, cada um até 40 caracteres. Com minúsculas e sem duplicação do lado do servidor.

Linguagem
locale string

Linguagem de tudo o que o signatário vê: página de assinatura, convite, lembretes, email de conclusão. Código BCP-47, por exemplo nl, nl-BE, en-GB, de, fr. Deixe vazio para herdar a linguagem da conta Certyneo que enviou o envelope. Um código não suportado é rejeitado com 400.

URL de redirecionamento
redirectUrl string

Onde o signatário é enviado após assinar. Substitui a chamada à ação padrão da Certyneo por um único botão "Continuar" apontando para aqui. Tem de começar por https:// — qualquer outra coisa é rejeitada com 400.

Iniciais em cada página
initialsOnEveryPage boolean

Carimbe automaticamente as iniciais do signatário no final de cada página de cada documento, além de qualquer campo que colocar por si próprio. Não é necessária configuração por página — o signatário preenche as iniciais uma vez e aplica-se em todo o lado. Ignora uma página onde esse assinador já tem um campo (por exemplo, a assinatura na última página).

Workspace
workspaceId string

Crie o envelope num espaço de trabalho partilhado para que todos os membros desse espaço possam ver e acompanhar. Deixa vazio para o guardares na tua própria conta. Deve ser dono do espaço de trabalho ou ser membro dele.

Devoluções

Body
Envelope

Descarregar documento assinado

Obtenha o PDF assinado, incluindo a página do certificado. Só depois de o envelope estar CONCLUÍDO — antes disso, devolve 409, por isso é ativado no "Envelope concluído" em vez de no sondamento.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Envelope ID
id True string

Identificador do envelope cujo documento assinado quer descarregar.

Devoluções

response
binary

Descarregar o trilho de auditoria

Obtenha o ficheiro de provas de um envelope preenchido — quem assinou, quando, de que IP, com que fatores de autenticação. Arquiva-o juntamente com o PDF assinado: é o que uma disputa de eIDAS desencadeia.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Envelope ID
id True string

Identificador do envelope cujo registo de auditoria quer descarregar.

Devoluções

response
binary

Eliminar envelope de rascunho

Apagar um envelope que nunca foi enviado — um fluxo que falhou a meio, um documento errado. Apenas DRAFT: uma vez que um envelope é enviado, este devolve um erro e não consegue recuperá-lo de um fluxo.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Envelope ID
id True string

Identificador do envelope do rascunho para eliminar.

Devoluções

Enviar envelope

Envie um envelope RASCUNHO aos destinatários para assinatura — este é o passo que realmente envia o email. "Criar envelope" só o guarda como rascunho; não envia nada por si só. Encadeia sempre esta ação logo após "Criar envelope" no teu fluxo, usando o ID do envelope que devolveu.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Envelope ID
id True string

Identificador do envelope de rascunho para enviar aos seus destinatários.

Devoluções

Body
Envelope

Listar envelopes

Recupere uma lista paginada de envelopes.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Página
page integer

Que página de resultados devolver. Começa em 1.

Tamanho da página
limit integer

Quantos envelopes devolver por página.

Status
status string

Devolva apenas os envelopes neste estado. Deixe vazio para devolver todos os estados.

Devoluções

Modelos de lista

Devolve os teus modelos de envelopes guardados. Usado para alimentar o seletor de modelos em "Criar envelope".

Devoluções

Recebe o envelope

Obtenha o estado atual e os detalhes de um envelope.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Envelope ID
id True string

Identificador do envelope a recuperar.

Devoluções

Body
Envelope

Acionadores

Quando ocorre um evento de envelope

Ativa um fluxo sempre que um dos eventos selecionados acontece em qualquer um dos teus envelopes (por exemplo, assinado, concluído, recusado). Apoiado por um webhook em tempo real — sem sondagens.

Quando ocorre um evento de envelope

Ativa um fluxo sempre que um dos eventos selecionados acontece em qualquer um dos teus envelopes (por exemplo, assinado, concluído, recusado). Apoiado por um webhook em tempo real — sem sondagens.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Events
events True array of string

Quais eventos envolvente/destinatários devem desencadear este fluxo?

Devoluções

Entregue assinada com HMAC-SHA256 no cabeçalho X-Certyneo-Signature (resumo hexadecimal do corpo JSON bruto, ligado ao segredo da subscrição). Verifica antes de confiar no payload num fluxo que atua sobre ele (ver /developers/webhooks).

Definições

DeleteResult

Nome Caminho Tipo Descrição
Sucesso
success boolean

É verdade quando o recurso foi apagado.

Pagination

Nome Caminho Tipo Descrição
total
total integer
página
page integer
pageSize
pageSize integer
pages
pages integer

Template

Nome Caminho Tipo Descrição
id
id string
Nome
name string
description
description string
signerCount
signerCount integer
documentCount
documentCount integer

TemplateList

Nome Caminho Tipo Descrição
dados
data array of Template
paginação
pagination Pagination

Recipient

Nome Caminho Tipo Descrição
E-mail do destinatário
email string
Nome do destinatário
name string
Função
role string
estado
status string
assinadoEm
signedAt string
Token de acesso
accessToken string

Abre a página de assinatura deste destinatário em https://certyneo.com/sign/<token>. No sandbox, nenhum email de convite é enviado, por isso é assim que assinas um envelope de teste tu próprio. Devolvido por "Criar envelope" e "Enviar envelope" — não por "Receber envelope", onde fica vazio. Trate-o como uma credencial: qualquer pessoa que a tenha pode assinar como destinatário, por isso não a registre nem coloque numa folha de cálculo.

Documento

Nome Caminho Tipo Descrição
id
id string
Nome
name string
mimeType
mimeType string
size
size integer
estado
status string

Envelope

Nome Caminho Tipo Descrição
id
id string
subject
subject string
mensagem
message string
estado
status string
Nível de assinatura
signatureLevel string
recipients
recipients array of Recipient
expira em
expiresAt string
createdAt
createdAt string
concluídoAt
completedAt string

EnvelopeList

Nome Caminho Tipo Descrição
dados
data array of Envelope
paginação
pagination Pagination

WebhookEventPayload

Entregue assinada com HMAC-SHA256 no cabeçalho X-Certyneo-Signature (resumo hexadecimal do corpo JSON bruto, ligado ao segredo da subscrição). Verifica antes de confiar no payload num fluxo que atua sobre ele (ver /developers/webhooks).

Nome Caminho Tipo Descrição
evento
event string
carimbo de data/hora
timestamp date-time
Envelope ID
data.envelopeId string

Sempre presente. Introduza isso em "Receber envelope" ou "Descarregar documento assinado".

Subject
data.subject string

Apresente apenas em eventos com envelopes.

Status
data.status string
Nível de assinatura
data.signatureLevel string

Presente no envelope.preenchido e destinatário.assinado.

Assinantes avançados de assinatura com chave pessoal
data.aesSignerCount integer

envelope.completed apenas num envelope AVANÇADO.

Certificado de assinatura avançada serial
data.aesCertificateSerial string

recipiente.assinado, quando o signatário assinou com uma chave de assinatura avançada pessoal.

Certificado de assinatura avançada SHA256
data.aesCertificateSha256 string

recipiente.assinado, quando o signatário assinou com uma chave de assinatura avançada pessoal.

Manifesto avançado de assinatura SHA256
data.aesManifestSha256 string

recipiente.assinado, quando o signatário assinou com uma chave de assinatura avançada pessoal.

Assinatura avançada com carimbo temporal
data.aesTimestamped boolean

recipiente.assinado, quando o signatário assinou com uma chave de assinatura avançada pessoal.

Contagem de destinatários
data.recipientCount integer

Apresente apenas em eventos com envelopes.

Contagem assinada
data.signedCount integer

Apresente apenas em eventos com envelopes.

ID do destinatário
data.recipientId string

Presente apenas nos eventos para destinatários.

E-mail do destinatário
data.email string

Presente apenas nos eventos para destinatários.

Nome do destinatário
data.name string

Presente apenas nos eventos para destinatários.

Papel do destinatário
data.role string

Presente apenas nos eventos para destinatários.

Assinado em
data.signedAt date-time

Presente apenas nos eventos para destinatários.

Visualizado em
data.viewedAt date-time

Presente apenas nos eventos para destinatários.

binário

Este é o tipo de dados básico 'binário'.