Certyneo (versão prévia)

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

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

Serviço	Classe	Regions
Copilot Studio	Premium	Todas as regiões Power Automate exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos	Standard	Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Azure Governamental regiões - 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 (GCC) – 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 (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

Contato
Name	Suporte do Certyneo
URL	https://certyneo.com/fr/contact
Email	support@certyneo.com

Metadados do conector
Publicador	Certyneo
Website	https://certyneo.com
Política de privacidade	https://certyneo.com/fr/legal/privacy
Categories	Operações de TI; Produtividade

Certyneo

O Certyneo é um serviço de assinatura eletrônica compatível com eIDAS. Esse conector permite que um fluxo envie documentos para assinatura, reaja em tempo real quando um signatário age e arquive o PDF assinado e seu arquivo de evidência onde quer que o restante da empresa mantenha seus registros.

O fluxo típico é de três etapas: um documento chega a algum lugar (uma biblioteca de documentos, uma caixa de correio, um envio de formulário), o fluxo cria e envia um envelope e um segundo fluxo disparado por envelope.completed downloads do PDF assinado e o armazena.

Publicador

Certyneo

Prerequisites

Você precisa de uma conta do Certyneo em um plano que inclua acesso à API. Planos gratuitos e pessoais podem criar chaves de API e assinar eventos, mas eles só recebem eventos para envelopes de área restrita – consulte problemas conhecidos e limitações abaixo.

Como obter credenciais

O conector é autenticado com uma chave de API Certyneo.

Entre no Certyneo e abra Configurações → Chaves de API.
Crie uma chave. As chaves dinâmicas começam com sk_live_chaves de área restrita com sk_test_.
Quando o conector solicitar a chave de API, cole a palavra Bearer, um espaço e, em seguida, a chave , por exemplo Bearer sk_live_abc123. Certyneo espera a palavra Bearer na frente da chave, e uma chave colada por conta própria é rejeitada com 401.

A chave carrega escopos. Uma chave sem envelopes:write poder criar ou enviar e uma chave sem webhooks:write poder retornar o gatilho. Conceda aos escopos que o fluxo realmente precisa.

Teste sem enviar email para ninguém

Uma chave de área restrita (sk_test_) exerce todo o pipeline sem enviar um único email de convite. Nada atinge uma caixa de entrada real, o que também significa que ninguém pode acessar a página de assinatura de um email. Portanto, crie envelope e envie um token de acesso para cada destinatário. Abra https://certyneo.com/sign/<access token> para assinar o envelope de teste por conta própria.

Trate esse token como uma credencial: qualquer pessoa que o mantém pode assinar como esse destinatário. Não registre-o em log e não solte-o em uma planilha.

Operações com suporte

Trigger

Quando ocorre um evento de envelope – é acionado nos eventos selecionados, apoiado por um webhook real em vez de sondagem. Eventos disponíveis:

envelope.created, envelope.sent, envelope.completed, envelope.declined, envelope.voided, , envelope.expired, , envelope.returned_to_sender, envelope.resubmitted, recipient.signed, , recipient.viewed, . recipient.approved

Cada carga carrega a ID do Envelope, em eventos de envelope e destinatário. Esse é o valor a ser alimentado nas ações abaixo.

As entregas são assinadas com HMAC-SHA256 no X-Certyneo-Signature cabeçalho – um resumo hexadecdecível do corpo JSON bruto, chaveado com o segredo da assinatura. Verifique-o antes que um fluxo aja no conteúdo.

Ações

Ação	O que faz
Listar modelos	Seus modelos de envelope salvos. Habilita o seletor de modelo.
Criar envelope	Cria um envelope DRAFT, de um modelo ou de documentos carregados.
Enviar envelope	Envia um envelope DRAFT para seus destinatários.
Obter envelope	Status atual e detalhes do destinatário.
Listar envelopes	Lista paginada, filtre por status.
Carregar documento	Carrega um PDF ou imagem e retorna uma ID do documento.
Baixar documento assinado	O PDF assinado, página de certificado incluída.
Baixar trilha de auditoria	O arquivo de evidência: quem assinou, quando, de qual IP, com quais fatores.
Excluir envelope de rascunho	Exclui um envelope que nunca foi enviado.

Limitações e problemas conhecidos

Um envelope enviado não pode ser recuperado de um fluxo.Excluir envelope de rascunho aceita apenas envelopes ainda em RASCUNHO — um fluxo que falhou no meio do caminho, um documento incorreto. Depois que um envelope tiver saído, ele retornará 409 e não haverá nenhuma operação de cancelamento na API hoje.

recipient.signed é acionado antes que o PDF assinado exista, inclusive para o último signatário. A montagem e a vedação do documento final ocorrem após esse evento, de modo que um fluxo que dispara recipient.signed e chama imediatamente o documento assinado download obtém 409 todas as vezes. Essa não é uma corrida que você pode vencer com um atraso – gatilho ativado envelope.completed em vez disso, que é acionado quando o PDF está no disco.

Planos gratuitos e pessoais recebem apenas eventos de área restrita. Ambos podem criar uma assinatura e o gatilho será mostrado como íntegro, mas os envelopes dinâmicos nunca a alcançarão. Se um gatilho parecer não fazer nada no tráfego real, verifique o plano antes de qualquer outra coisa.

Use um modelo ou documentos, nunca ambos. Um modelo traz seus próprios documentos e seus próprios campos de assinatura. Ao compilar a partir de documentos carregados, você também deve fornecer Campos – um envelope cujo signatário não tem onde assinar é recusado no momento do envio com 409 signer_without_field, não no momento da criação.

Prefira o texto de âncora em vez de 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 um fallback para que um campo cuja âncora não seja encontrada mantenha uma posição literal em vez de desaparecer.

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

Um documento limpo retorna 410, não 409. 409 significa "ainda não pronto, volte depois envelope.completed". 410 significa que o documento assinado foi deliberadamente excluído sob a política de retenção e nunca mais voltará. Um loop de repetição deve desistir do 410.

Erros comuns e soluções

Resposta	Cause	Solução
401	Chave ausente ou colada sem `Bearer` na frente	Insira novamente a conexão como `Bearer sk_live_...`
403	A chave não tem o escopo para esta operação	Emitir novamente a chave com os escopos de que o fluxo precisa
409 no download	O envelope ainda não foi concluído	Gatilho ativado em `envelope.completed` vez de sondagem
409 no envio	`signer_without_field` — um signatário não tem nenhum campo de assinatura	Adicionar campos ou compilar a partir de um modelo
409 na exclusão	O envelope já foi enviado	Os envelopes enviados não podem ser excluídos ou recuperados
410 no download	O documento foi limpo sob a política de retenção	Pare de tentar novamente; o arquivo se foi

Os erros carregam uma mensagem legível error por humanos e um estável code. Ramificação – code a mensagem pode ser reformulada.

Support

Documentação: https://certyneo.com/developers
Referência do webhook: https://certyneo.com/developers/webhooks
Suporte: https://certyneo.com/support

Criando uma conexão

O conector dá suporte aos 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.

Essa não é uma conexão compartilhável. Se o aplicativo de energia 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

Baixar documento assinado	Obtenha o PDF assinado, página de certificado incluída. Somente depois que o envelope for CONCLUÍDO – antes disso, ele retornará 409, portanto, dispare em "Envelope concluído" em vez de sondagem.
Baixar trilha de auditoria	Obtenha o arquivo de evidência para um envelope concluído – quem assinou, quando, de qual IP, com quais fatores de autenticação. Arquive-o junto com o PDF assinado: é o que uma disputa eIDAS ativa.
Carregar documento	Carregue um PDF ou imagem (no máximo 50 MB). Retorna uma ID de documento – passe-a para "Criar envelope" em "Documentos".
Criar envelope	Crie um novo envelope no status DRAFT, seja de um modelo salvo ou diretamente dos documentos que você carregou com "Carregar documento". Preencha exatamente um de "Modelo" ou "Documentos". Com documentos, adicione "Campos" também para que cada signatário tenha algum lugar para assinar . A maneira mais simples é citar uma frase do documento em "Texto de âncora" em vez de trabalhar as coordenadas. IMPORTANTE: essa ação só cria o envelope – nenhum email é enviado ainda. Adicione a ação "Enviar envelope" logo após esta no fluxo para, na verdade, enviá-la aos destinatários.
Enviar envelope	Envie um envelope DRAFT para seus destinatários para assinatura. Essa é a etapa que realmente envia o email. "Criar envelope" salva-o apenas como um rascunho; ele não envia nada por conta própria. Sempre encadeia essa ação logo após "Criar envelope" em seu fluxo, usando a ID do envelope retornada.
Excluir envelope de rascunho	Exclua um envelope que nunca foi enviado – um fluxo que falhou no meio do caminho, um documento errado. SOMENTE RASCUNHO: depois que um envelope tiver saído, isso retornará um erro e você não poderá retirá-lo de um fluxo.
Listar envelopes	Recupere uma lista paginada de envelopes.
Listar modelos	Retorna seus modelos de envelope salvos. Usado para alimentar o seletor de modelo em "Criar envelope".
Obter envelope	Obtenha o status atual e os detalhes de um envelope.

Baixar documento assinado

ID da operação:: DownloadSignedDocument

Obtenha o PDF assinado, página de certificado incluída. Somente depois que o envelope for CONCLUÍDO – antes disso, ele retornará 409, portanto, dispare em "Envelope concluído" em vez de sondagem.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Envelope ID	id	True	string	Identificador do envelope cujo documento assinado você deseja baixar.

Retornos

response: binary

Baixar trilha de auditoria

ID da operação:: DownloadAuditTrail

Obtenha o arquivo de evidência para um envelope concluído – quem assinou, quando, de qual IP, com quais fatores de autenticação. Arquive-o junto com o PDF assinado: é o que uma disputa eIDAS ativa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Envelope ID	id	True	string	Identificador do envelope cuja trilha de auditoria você deseja baixar.

Retornos

response: binary

Carregar documento

ID da operação:: UploadDocument

Carregue um PDF ou imagem (no máximo 50 MB). Retorna uma ID de documento – passe-a para "Criar envelope" em "Documentos".

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Arquivo	file	True	file	O PDF ou a imagem a ser carregada, no máximo, 50 MB.
Nome do documento	name		string	Nome para arquivar o documento em. O padrão é o nome do arquivo carregado.

Retornos

Body: Document

Criar envelope

ID da operação:: CreateEnvelope

Crie um novo envelope no status DRAFT, seja de um modelo salvo ou diretamente dos documentos que você carregou com "Carregar documento". Preencha exatamente um de "Modelo" ou "Documentos". Com documentos, adicione "Campos" também para que cada signatário tenha algum lugar para assinar . A maneira mais simples é citar uma frase do documento em "Texto de âncora" em vez de trabalhar as coordenadas. IMPORTANTE: essa ação só cria o envelope – nenhum email é enviado ainda. Adicione a ação "Enviar envelope" logo após esta no fluxo para, na verdade, enviá-la aos destinatários.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Subject	subject	True	string	Assunto/título do envelope.
Message	message		string	Mensagem mostrada aos destinatários.
Template	templateId		string	Escolha um modelo salvo. Use este OU "Documentos", não ambos — um modelo traz seus próprios documentos e campos de assinatura.
Documents	documentIds		array of string	IDs de documento de "Carregar documento". Use este OU "Modelo", não ambos. Quando você usa documentos, adicione "Campos" também — um envelope cujo signatário não tem campo de assinatura é recusado no momento do envio.
Email do signatário	recipientEmail	True	string	Deve corresponder a um dos destinatários acima, exatamente.
Número do documento	documentIndex		integer	Qual documento carrega esse campo, contando de 0 na ordem fornecida acima. Deixe vazio quando houver apenas um documento.
Página	pageNumber	True	integer
Tipo de campo	fieldType	True	string
Texto de âncora (recomendado)	anchorText		string	Texto a ser buscado no documento – o campo é colocado ao lado dele, para que você não precise de coordenadas. Não diferencia maiúsculas de minúsculas e encontrado mesmo quando o PDF divide a frase entre execuções. Deixe vazio para usar X/Y.
Posicionamento da âncora	anchorPlacement		string	Onde colocar o campo em relação ao texto de âncora.
Ocorrência de âncora	anchorIndex		integer	Qual ocorrência usar, contando a partir de 0, quando o texto de âncora é exibido várias vezes.
X	x	True	number	Pontos da borda esquerda. Ignorado quando a âncora é encontrada – mantida como um fallback para que o campo nunca desapareça.
Y	y	True	number	Pontos da borda SUPERIOR. Ignorado quando a âncora é encontrada – mantida como um fallback.
Largura	width	True	number
Altura	height	True	number
Email do destinatário	email	True	string
Nome do destinatário	name		string
Função	role		string
status	status		string
signedAt	signedAt		string
Token de acesso	accessToken		string	Abre a página de assinatura desse destinatário no https://certyneo.com/sign/<token>. Na área restrita, nenhum email de convite sai, então é assim que você assina um envelope de teste por conta própria. Retornado por "Criar envelope" e "Enviar envelope" – não por "Obter envelope", onde ele permanece vazio. Trate-a como uma credencial: qualquer pessoa que a contenha pode assinar como este destinatário, portanto, não registre-a ou solte-a em uma planilha.
Nível de assinatura	signatureLevel		string
Expira em	expiresAt		date-time
Category	category		string	Classificação de negócios mostrada na lista de envelopes. Deixe vazio e Certyneo infere um do assunto.
Tags	tags		array of string	Rótulos de formulário livre – código do projeto, referência do cliente, status interno. Até 10, cada um com até 40 caracteres. Lado do servidor em letras minúsculas e des duplicadas.
Linguagem	locale		string	Idioma 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 o idioma da conta Certyneo que envia o envelope. Um código sem suporte é rejeitado com um 400.
URL de redirecionamento	redirectUrl		string	Para onde o signatário é enviado após a assinatura. Substitui a chamada à ação padrão do Certyneo por um único botão "Continuar" apontando aqui. Deve começar com https:// – qualquer outra coisa é rejeitada com um 400.
Iniciais em cada página	initialsOnEveryPage		boolean	Carimba automaticamente as iniciais do signatário na parte inferior de cada página de cada documento, além de qualquer campo que você mesmo colocar. Nenhuma configuração por página é necessária: o signatário preenche suas iniciais uma vez e se aplica em todos os lugares. Ignora uma página em que esse signatário já tem um campo (por exemplo, a assinatura na última página).
Workspace	workspaceId		string	Crie o envelope em um workspace compartilhado para que cada membro desse workspace possa vê-lo e segui-lo. Deixe vazio para mantê-lo em sua própria conta. Você deve ser proprietário do workspace ou ser membro dele.

Retornos

Body: Envelope

Enviar envelope

ID da operação:: SendEnvelope

Envie um envelope DRAFT para seus destinatários para assinatura. Essa é a etapa que realmente envia o email. "Criar envelope" salva-o apenas como um rascunho; ele não envia nada por conta própria. Sempre encadeia essa ação logo após "Criar envelope" em seu fluxo, usando a ID do envelope retornada.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Envelope ID	id	True	string	Identificador do envelope de rascunho para expedir para seus destinatários.

Retornos

Body: Envelope

Excluir envelope de rascunho

ID da operação:: DeleteDraftEnvelope

Exclua um envelope que nunca foi enviado – um fluxo que falhou no meio do caminho, um documento errado. SOMENTE RASCUNHO: depois que um envelope tiver saído, isso retornará um erro e você não poderá retirá-lo de um fluxo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Envelope ID	id	True	string	Identificador do envelope de rascunho a ser excluído.

Retornos

Body: DeleteResult

Listar envelopes

ID da operação:: ListEnvelopes

Recupere uma lista paginada de envelopes.

Parâmetros

Nome	Chave	Tipo	Description
Página	page	integer	Qual página de resultados retornar. Começa em 1.
Tamanho da página	limit	integer	Quantos envelopes devem ser retornados por página.
Status	status	string	Retorne apenas os envelopes nesse status. Deixe vazio para retornar todos os status.

Retornos

Body: EnvelopeList

Listar modelos

ID da operação:: ListTemplates

Retorna seus modelos de envelope salvos. Usado para alimentar o seletor de modelo em "Criar envelope".

Retornos

Body: TemplateList

Obter envelope

ID da operação:: GetEnvelope

Obtenha o status atual e os detalhes de um envelope.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Envelope ID	id	True	string	Identificador do envelope a ser recuperado.

Retornos

Body: Envelope

Gatilhos

Quando ocorre um evento de envelope

Dispara um fluxo sempre que um dos eventos selecionados ocorre em qualquer um dos envelopes (por exemplo, assinado, concluído, recusado). Apoiado por um webhook em tempo real , sem sondagem.

Quando ocorre um evento de envelope

ID da operação:: SubscribeEnvelopeEvents

Dispara um fluxo sempre que um dos eventos selecionados ocorre em qualquer um dos envelopes (por exemplo, assinado, concluído, recusado). Apoiado por um webhook em tempo real , sem sondagem.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Eventos	events	True	array of string	Quais eventos de envelope/destinatário devem disparar esse fluxo.

Retornos

Entregue assinado com HMAC-SHA256 no cabeçalho X-Certyneo-Signature (resumo hex do corpo JSON bruto, chaveado com o segredo da assinatura). Verifique-o antes de confiar no conteúdo em um fluxo que atua nele (consulte /developers/webhooks).

Body: WebhookEventPayload

Definições

DeleteResult

Nome	Caminho	Tipo	Description
Êxito	success	boolean	True quando o recurso foi excluído.

Pagination

Nome	Caminho	Tipo
total	total	integer
página	page	integer
pageSize	pageSize	integer
Páginas	pages	integer

Template

Nome	Caminho	Tipo
id	id	string
nome	name	string
description	description	string
signerCount	signerCount	integer
documentCount	documentCount	integer

TemplateList

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

Recipient

Nome	Caminho	Tipo	Description
Email do destinatário	email	string
Nome do destinatário	name	string
Função	role	string
status	status	string
signedAt	signedAt	string
Token de acesso	accessToken	string	Abre a página de assinatura desse destinatário no https://certyneo.com/sign/<token>. Na área restrita, nenhum email de convite sai, então é assim que você assina um envelope de teste por conta própria. Retornado por "Criar envelope" e "Enviar envelope" – não por "Obter envelope", onde ele permanece vazio. Trate-a como uma credencial: qualquer pessoa que a contenha pode assinar como este destinatário, portanto, não registre-a ou solte-a em uma planilha.

Documento

Nome	Caminho	Tipo
id	id	string
nome	name	string
Tipo MIME	mimeType	string
size	size	integer
status	status	string

Envelope

Nome	Caminho	Tipo
id	id	string
subject	subject	string
mensagem	message	string
status	status	string
signatureLevel	signatureLevel	string
recipients	recipients	array of Recipient
expiresAt	expiresAt	string
createdAt	createdAt	string
completedAt	completedAt	string

EnvelopeList

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

WebhookEventPayload

Nome	Caminho	Tipo	Description
evento	event	string
carimbo de data/hora	timestamp	date-time
Envelope ID	data.envelopeId	string	Sempre presente. Alimente-o em "Obter envelope" ou "Baixar documento assinado".
Subject	data.subject	string	Apresentar somente em eventos de envelope.
Status	data.status	string
Nível de assinatura	data.signatureLevel	string	Presente em envelope.completed e recipient.signed.
Signatários de assinatura avançados com uma chave pessoal	data.aesSignerCount	integer	envelope.concluído somente em um envelope ADVANCED.
Serial de certificado de assinatura avançado	data.aesCertificateSerial	string	recipient.signed, quando o signatário assinou com uma chave de assinatura avançada pessoal.
Certificado de assinatura avançado SHA256	data.aesCertificateSha256	string	recipient.signed, quando o signatário assinou com uma chave de assinatura avançada pessoal.
Manifesto de assinatura avançado SHA256	data.aesManifestSha256	string	recipient.signed, quando o signatário assinou com uma chave de assinatura avançada pessoal.
Carimbo de data/hora de assinatura avançado	data.aesTimestamped	boolean	recipient.signed, quando o signatário assinou com uma chave de assinatura avançada pessoal.
Contagem dos destinatários	data.recipientCount	integer	Apresentar somente em eventos de envelope.
Contagem assinada	data.signedCount	integer	Apresentar somente em eventos de envelope.
ID do destinatário	data.recipientId	string	Apresentar somente em eventos de destinatário.
Email do destinatário	data.email	string	Apresentar somente em eventos de destinatário.
Nome do destinatário	data.name	string	Apresentar somente em eventos de destinatário.
Função de destinatário	data.role	string	Apresentar somente em eventos de destinatário.
Assinado em	data.signedAt	date-time	Apresentar somente em eventos de destinatário.
Exibido em	data.viewedAt	date-time	Apresentar somente em eventos de destinatário.

binário

Esse é o tipo de dados básico 'binary'.