Do sandbox ao primeiro envio, na sua linguagem
Ofereça assinatura eletrônica aos clientes do seu produto: o seu sistema cria o documento, convida os signatários e acompanha cada assinatura pela API.
# Envia um documento para o seu workspace
curl -X POST \
https://sandbox.assinafy.com.br/v1/accounts/{account_id}/documents \
-H 'X-Api-Key: {api_key}' \
-F 'file=@contrato.pdf'Sandbox de assinatura eletrônica: do zero ao primeiro envio
São quatro passos. A resposta de cada um devolve o ID que o seguinte usa.
ASSINAFY_API_KEY=sua_chave ASSINAFY_ACCOUNT_ID=id_do_workspace
curl -X POST …/documents \ -F 'file=@contrato.pdf'
{ "method": "virtual", "signers": [{ "id": "{signer_id}" }] }
Gere as credenciais de sandbox
Crie uma conta de sandbox, gere a chave de API em Minha conta → API e copie o ID do workspace em Minha conta → Workspaces. A chave é sua, de usuário, e vale para todos os workspaces em que você está.
ASSINAFY_API_KEYASSINAFY_ACCOUNT_IDEnvie o documento
Mande o PDF original como multipart form data. Guarde o ID do documento que vem na resposta.
Cadastre os signatários
Crie cada signatário com nome e contato. O método de autenticação de cada um entra no passo seguinte.
Solicite as assinaturas
Crie a solicitação de assinatura (o assignment), com o método de autenticação de cada signatário, e receba os webhooks para acompanhar o andamento.
Cada passo do documento chega ao seu sistema, sem polling
Você liga só os eventos que interessam e confere cada disparo na tela de logs.
- Uma nova tentativa automática e, se ela também falhar, um aviso por e-mail
- Reenvio do evento pela API, quando você precisar
- Histórico de disparos por 7 dias, com filtro por evento e status
document_uploaded200signature_requested200signer_viewed_document200signer_signed_document200document_ready200Ver os 15 eventos
document_uploadeddocument_metadata_readydocument_preparedassignment_createdsignature_requesteddocument_readyuser_rejected_documentdocument_processing_failedsigner_createdsigner_email_verifiedsigner_whatsapp_verifiedsigner_data_confirmedsigner_viewed_documentsigner_signed_documentsigner_rejected_documentEscolha o SDK oficial da sua linguagem
REST, SDKs e CLI. Autentique com chave de API, liberada desde o plano grátis, ou com OAuth.
Ver todos os SDKsAgentes de IA: use o MCP Server da Assinafy
MCP Server hospedado em mcp.assinafy.com.br/mcp, por Streamable HTTP. A conexão é OAuth do próprio usuário, sem chave de API, e a autorização vale 30 dias.
Ver o MCP ServerTenho quatro ferramentas da Assinafy:
request_signaturespedir a assinatura de um documentofollow_up_assignmentlembrar quem ainda não assinoufind_documentsconsultar o status dos documentosverify_documentconferir um documento assinado
Conecte a Assinafy ao que seu time já usa
CRM, editor de texto e automações já têm integração pronta. Para automatizar o envio, conecte o Zapier, o Make ou o n8n.
Ver todas as integraçõesNão achou sua ferramenta? Peça aqui
Perguntas sobre o sandbox e a integração
O que os devs perguntam antes de integrar.
Crie a conta, use a chave de API que já vem aprovada nela e teste no sandbox. O passo a passo, do envio do PDF à solicitação de assinatura, está nesta página.
Use o da linguagem do seu backend: TypeScript, Python, Ruby, Go, Rust, .NET, PHP, Java ou Object Pascal. Para apps, há clientes nativos iOS e Android. Também dá para usar a API REST direto, sem SDK.
Por webhooks para eventos de documento: seu sistema é avisado, sem precisar consultar a API.
Mantenha a chave só no servidor. Ela não pode ir em bundle de navegador nem em aplicativo.
A chave de API já vem aprovada na sua conta, em todos os planos, inclusive no grátis. Não há add-on nem taxa por chamada para liberar a API. O que consome créditos são os envios acima da franquia do plano e os métodos de autenticação pagos.
Dá. Há integrações prontas com HubSpot, Google Workspace, Microsoft Word e Outlook, e automação por Zapier e Make. Veja o catálogo de integrações.
A Assinafy faz uma nova tentativa automática e, se ela também falhar, avisa você por e-mail. Você pode reenviar o evento pela API e consultar o histórico de disparos, com filtro por evento e status.
Crie a conta e gere a sua chave de API
A chave já vem aprovada, inclusive no plano grátis, e o sandbox é separado da produção.