Pular para o conteúdo

Glossário · Atualizado em

API de assinatura eletrônica

Uma API de assinatura eletrônica permite que um software crie, envie, acompanhe e baixe solicitações de assinatura de forma programática, em vez de usar o aplicativo web.

O que significa API de assinatura eletrônica?

Uma API de assinatura eletrônica é uma interface de programação que permite ao seu próprio software enviar documentos para assinatura, acompanhar o status e recuperar os arquivos assinados, sem que ninguém precise clicar no aplicativo web do provedor. Em resumo, é como os desenvolvedores automatizam a assinatura e a conectam a CRMs, sistemas de RH e produtos sob medida.

Uma integração típica funciona assim: o seu sistema se autentica com uma chave de API, envia uma requisição para criar uma solicitação de assinatura a partir de um PDF ou de um modelo, lista os signatários e a ordem deles e recebe um ID de volta. O provedor então manda e-mails aos signatários ou devolve uma URL para assinatura incorporada. Quando algo muda, como uma assinatura ou uma recusa, o provedor chama o seu webhook, e o seu sistema baixa o documento concluído e a sua trilha de auditoria.

Pense numa agência de recrutamento que coloca prestadores todas as semanas. Em vez de um recrutador subir cada contrato manualmente, o sistema de recrutamento chama a API no momento em que a contratação é confirmada, preenche o modelo com os dados do prestador e arquiva automaticamente a cópia assinada na ficha do candidato.

Um equívoco é achar que API é coisa só de grandes empresas. Equipes pequenas com um único fluxo repetitivo também ganham com ela, e ferramentas no-code muitas vezes chamam a API por você. Outro é achar que documentos assinados via API são juridicamente diferentes; são as mesmas assinaturas, com a mesma trilha de auditoria, só que iniciadas por código.

A API é a base da assinatura incorporada e, muitas vezes, do envio em massa, e normalmente se apoia em modelos para que os documentos sejam gerados de forma consistente.

Ao avaliar qualquer API de assinatura eletrônica, olhe os detalhes práticos: documentação clara, sandbox ou modo de teste, limites de requisição razoáveis, novas tentativas de webhook e a possibilidade de baixar tanto o PDF assinado quanto a trilha de auditoria. Veja como os erros são informados e se a API consegue usar os mesmos modelos que a sua equipe gerencia no aplicativo web. São esses detalhes que decidem se uma integração leva um dia ou um mês, e se ela continua funcionando em silêncio depois do lançamento.

Nossa opinião: se assinar é uma etapa de um processo que o seu software já executa, uma API economiza horas de verdade e evita erros de copiar e colar. Se você manda um punhado de contratos por semana, o aplicativo web é mais rápido de configurar e mais fácil de manter.

A API REST do eSignSimple está no ar: autentique-se com uma chave de API Bearer, crie e envie documentos a partir de um PDF ou de um modelo, acompanhe o status e a trilha de auditoria, baixe o PDF assinado e receba webhooks quando os documentos forem concluídos, recusados ou cancelados. SDKs, sandbox e assinatura incorporada estão no nosso roadmap. Todo documento concluído inclui trilha de auditoria, certificado de conclusão e um hash SHA-256 verificável na nossa página pública. A referência completa está na nossa documentação para desenvolvedores.

Qual é um exemplo de API de assinatura eletrônica?

Uma pequena empresa de SaaS quer que todo novo cliente corporativo assine um pedido de compra automaticamente. Quando um negócio é marcado como ganho no CRM, um script chama a API REST do eSignSimple com uma chave de API, cria um documento a partir do modelo de pedido com os dados do cliente e o envia. Um webhook avisa o sistema quando o documento é concluído, e o script baixa o PDF assinado para a ficha do cliente.

Quais termos estão relacionados?

  • Modelo: Um modelo de assinatura eletrônica é um documento reutilizável com papéis de signatário e campos já definidos, para enviar o mesmo contrato várias vezes sem configurá-lo de novo.
  • Envio em massa: O envio em massa permite mandar um documento ou modelo para muitos destinatários de uma vez, com cada pessoa recebendo e assinando a própria cópia.
  • Formulário web (link de assinatura): Na assinatura eletrônica, um formulário web é uma página hospedada com link público para preencher e assinar, em que qualquer pessoa conclui e assina um documento sem convite prévio.
  • Assinatura incorporada (embedded signing): A assinatura incorporada permite que as pessoas assinem documentos dentro do seu próprio site ou aplicativo, em vez de seguir um link por e-mail até o site do provedor de assinatura eletrônica.

Perguntas frequentes

Como me autentico na API do eSignSimple?

Crie uma chave de API nas configurações da sua conta e envie-a como token Bearer no cabeçalho Authorization de cada requisição. As chaves começam com es_live_ e devem ser guardadas em segredo como uma senha, em variáveis de ambiente e nunca em código do lado do cliente. Você pode revogar uma chave a qualquer momento.

O que posso fazer com a API do eSignSimple?

Você pode criar documentos a partir de um PDF ou de um modelo, adicionar signatários, enviá-los, acompanhar o status, ler a trilha de auditoria e baixar o PDF final assinado. Webhooks avisam o seu servidor quando um documento é concluído, recusado ou cancelado. Os detalhes de todos os endpoints estão na página /developers.

O eSignSimple oferece SDKs ou sandbox?

Ainda não. A API REST funciona com qualquer linguagem capaz de fazer requisições HTTP, mas hoje não publicamos SDKs oficiais nem um ambiente de sandbox separado. Os dois estão no nosso roadmap. Para testar, muitos desenvolvedores enviam documentos para os próprios endereços de e-mail.

Colete a próxima assinatura ainda hoje.

Comece com 5 documentos grátis por mês. Sem cartão de crédito.