API do TapSign: chaves, webhooks e limites de uso

Criar uma chave

1. No computador, abra Integrações no menu.
2. Na aba API Keys, clique em Nova API Key, dê um nome e clique em Criar.
3. Copie a chave na hora: ela aparece uma única vez. Depois, a lista mostra só o começo dela.

• Envie a chave no cabeçalho Authorization: Bearer tsk_....
• Use sempre HTTPS.
• Guarde a chave como uma senha e não a coloque em código que roda no navegador.

Fluxo para enviar um documento

1. POST /v1/documents: envia o arquivo PDF ou DOCX, com até 10 MB, em multipart, nos campos file e title.
2. POST /v1/envelopes: cria o envelope do documento.
3. POST /v1/envelopes/{id}/signers: adiciona os signatários.
4. POST /v1/envelopes/{id}/send: envia os links de assinatura.

Para gerar um documento a partir de um modelo, com um signatário, use POST /v1/integration/documents/create-from-template.

Webhooks

Em Integrações, aba Webhooks, clique em Novo Webhook e informe nome, URL, secret e eventos.

• A URL precisa usar HTTPS e não pode apontar para rede privada.
• Informe um secret. Cada chamada leva o cabeçalho X-Webhook-Signature, com o HMAC-SHA256 do corpo JSON, em hexadecimal, calculado com esse secret.
• Eventos: doc_viewed, doc_signed, doc_refused, doc_completed, doc_canceled e doc_expired.
• Hoje, doc_signed e doc_completed são enviados quando o documento recebe todas as assinaturas.
• Só uma resposta 2xx conta como entrega. Sem ela, o TapSign tenta de novo, com intervalos crescentes, em até 5 tentativas no total.

Limites de uso

• Até 60 requisições por minuto por chave. Algumas rotas têm limite menor.
• Acima do limite, a API responde 429, com o cabeçalho Retry-After.
• As respostas trazem os cabeçalhos X-Rate-Limit-Limit e X-Rate-Limit-Remaining.
• Arquivos com até 10 MB.

Outras ferramentas

O TapSign não tem integração nativa com ferramentas de automação. Dá para conectar qualquer ferramenta que faça chamadas a uma API REST ou que receba webhooks.