Pular para o conteúdo
Desenvolvedores

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.

criar-documento.sh
# 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'
200 Documento criado com sucesso
Chave de API no plano grátis
Sandbox separado
Webhooks

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.

Credenciais
.env
ASSINAFY_API_KEY=sua_chave
ASSINAFY_ACCOUNT_ID=id_do_workspace
Ficam só no servidor, nunca no navegador
Enviar o documento
POST /documents
curl -X POST …/documents \
  -F 'file=@contrato.pdf'
↓
contrato.pdfEnviando✓ Criado
Signatários
Novos signatários
Quem assina
ALAna Limaana@exemplo.com
Carlos Souzacarlos@exemplo.com
Solicitação de assinatura
POST /assignments
{ "method": "virtual",
  "signers": [{ "id": "{signer_id}" }] }
↓
contrato.pdfAguardando assinatura✓ Assinado
01

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_ID
02

Envie o documento

Mande o PDF original como multipart form data. Guarde o ID do documento que vem na resposta.

03

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.

04

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.

Webhooks

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
POST /seu-sistema/webhooks
09:12:03document_uploaded200
09:12:05signature_requested200
09:14:41signer_viewed_document200
09:16:10signer_signed_document200
09:16:12document_ready200
Ver 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_document
Integração

Escolha 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 SDKs
TypeScript
# Instalação
npm install @assinafy/sdk

# Uso
import { AssinafyClient } from '@assinafy/sdk';

const client = new AssinafyClient({
  apiKey: process.env.ASSINAFY_API_KEY!,
  accountId: process.env.ASSINAFY_ACCOUNT_ID!,
});

const resultado = await client.uploadAndRequestSignatures({
  source: { filePath: './contrato.pdf' },
  signers: [
    { name: 'João Silva', email: 'joao@exemplo.com.br' },
  ],
  message: 'Por favor, assine este contrato',
});
MCP Server

Agentes 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 Server
Abra o passo a passo no seu agente
Agente de IAMCP Assinafy
Quais ferramentas você tem?Workspace autorizadoFerramentas listadas

Tenho quatro ferramentas da Assinafy:

  • request_signaturespedir a assinatura de um documento
  • follow_up_assignmentlembrar quem ainda não assinou
  • find_documentsconsultar o status dos documentos
  • verify_documentconferir um documento assinado
Pergunte ao seu agente
Sem código

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ções

Nã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 e gere a sua chave de API

A chave já vem aprovada, inclusive no plano grátis, e o sandbox é separado da produção.