Coloque a assinatura dentro do seu próprio produto.

A API do eSignSimple já está no ar?

O seu próprio software agora pode criar documentos, enviá-los para assinatura, acompanhar o status e baixar as cópias assinadas sem ninguém entrar em um painel. A API REST fica em https://esignsimple.com/api/v1, e a referência completa, com exemplos de requisição e resposta, está na nossa página para desenvolvedores.

Os signatários alcançados pela API têm exatamente a mesma experiência de assinatura sem cadastro e as mesmas provas dos documentos enviados pelo painel: trilha de auditoria, certificado de conclusão e um hash SHA-256 que qualquer pessoa pode conferir na nossa página pública de verificação.

Como a API funciona?

Crie um documento com POST /documents. Você manda uma requisição multipart com o PDF e uma parte JSON listando signatários e campos, em que as posições dos campos são dadas como frações da página, então você não precisa se preocupar com pontos de PDF nem tamanhos de página. O documento é enviado na hora, ou fica como rascunho se você passar send:false.

Já tem um modelo no painel? POST /templates/{id}/send preenche os signatários e envia. GET /documents lista seus documentos com filtro de status e paginação por cursor via before. GET /documents/{id} retorna o status, os signatários e a trilha de auditoria completa, e GET /documents/{id}/download retorna o PDF assinado quando o documento é concluído, ou o original com ?file=original.

Você também pode anular um documento em andamento com POST /documents/{id}/void, excluir um com DELETE /documents/{id} e consultar seu plano e uso atual com GET /me.

Como funcionam a autenticação e as chaves de API?

Toda requisição usa uma chave de API Bearer. Você cria e revoga chaves em Configurações → Desenvolvedores. A chave aparece uma única vez, no momento da criação, e guardamos só um hash, então copie-a para o seu gerenciador de segredos na hora. Se uma chave vazar, revogue e crie outra; nada mais precisa mudar.

A mesma API também aceita tokens de ID do Firebase, que é o que o nosso futuro aplicativo móvel vai usar. É uma escolha deliberada: construímos nossos próprios apps sobre a mesma API pública que você usa, então ela é exercitada todos os dias.

Quais webhooks você pode receber?

Em vez de ficar consultando, registre um endpoint HTTPS para a sua conta e nós o notificamos quando algo acontecer. Os eventos são document.completed, document.declined, document.voided e signer.signed.

Cada entrega é assinada com HMAC-SHA256 e a assinatura vai no cabeçalho esign-signature, para você confirmar que a requisição veio mesmo de nós antes de agir. Se o seu endpoint falhar, tentamos de novo uma vez. Nosso conselho: trate os webhooks como um gatilho e chame GET /documents/{id} para obter o estado oficial.

O que as pessoas constroem com a API?

Um CRM ou ferramenta de orçamentos que envia o contrato no momento em que o negócio é marcado como ganho. Um sistema de RH que envia um kit de admissão a partir de um modelo quando uma contratação é confirmada. Uma ferramenta imobiliária que envia o contrato de locação e arquiva o PDF assinado no cadastro do imóvel quando chega o document.completed. Um script interno que acaba com a cópia manual de linhas de planilha para contratos.

Se você envia meia dúzia de documentos por semana, provavelmente nem precisa da API. Os modelos, o envio em massa e os formulários web do painel resolvem com muito menos esforço.

Quanto custa a API?

Não existe plano de API separado. Valem os mesmos limites de plano do aplicativo web: o plano Grátis inclui 5 documentos por mês e o Pessoal é ilimitado (veja os preços). Documentos criados pela API contam exatamente como documentos enviados pelo painel.

Grandes fornecedores como DocuSign, Dropbox Sign e Adobe costumam cobrar pelas APIs separadamente dos planos de usuário, muitas vezes com base em volumes anuais de envelopes, e os planos de API de entrada podem custar bem mais do que as assinaturas padrão. Confira os sites deles para ver os preços atuais.

O que ainda não está incluído?

Somos honestos sobre as lacunas. Ainda não há iframe de assinatura incorporada, então os signatários continuam assinando pelo link que enviamos por e-mail. Não há SDKs oficiais; a API é HTTP e JSON puros, então qualquer linguagem com um cliente HTTP funciona. Não há ambiente sandbox separado, então teste com uma conta grátis e seus próprios endereços de e-mail. Tudo isso está no nosso roadmap.

Por que começamos com uma API pequena?

Começamos enxutos de propósito. Uma API pequena que faz bem o fluxo mais comum, com limites previsíveis e sem ligação de vendas, é mais útil do que uma superfície enorme que leva semanas para integrar. Se faltar algo de que você precisa, conte o que está construindo; são as integrações reais que decidem o que adicionamos a seguir.

Quais endpoints da API existem hoje?