Integre a assinatura eletrônica no seu stack
Envie envelopes, acompanhe assinaturas, receba webhooks. API REST simples, OpenAPI 3.0, exemplos curl/Node/Python — tudo para conectar Certyneo ao seu HRIS, CRM ou software de negócios em poucas horas.
Início rápido
Três etapas: crie uma chave API a partir das configurações, codifique seu PDF em base64, envie. A resposta contém o `signUrl` que você pode compartilhar diretamente com o destinatário.
curl -X POST https://certyneo.com/api/v1/envelopes \
-H "Authorization: Bearer ck_live_xxxxxxxxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
"subject": "Contrat de prestation",
"signers": [
{ "email": "[email protected]", "name": "Marie Dubois" }
],
"documents": [
{ "name": "contrat.pdf", "base64Pdf": "<base64>" }
]
}'// npm install @certyneo/sdk (or call fetch directly)
const r = await fetch("https://certyneo.com/api/v1/envelopes", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CERTYNEO_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
subject: "Contrat de prestation",
signers: [{ email: "[email protected]", name: "Marie Dubois" }],
documents: [{ name: "contrat.pdf", base64Pdf }],
}),
});
const envelope = await r.json();
console.log(envelope.id, envelope.signers[0].signUrl);import requests, base64, os
with open("contrat.pdf", "rb") as f:
base64_pdf = base64.b64encode(f.read()).decode()
r = requests.post(
"https://certyneo.com/api/v1/envelopes",
headers={"Authorization": f"Bearer {os.environ['CERTYNEO_API_KEY']}"},
json={
"subject": "Contrat de prestation",
"signers": [{"email": "[email protected]", "name": "Marie Dubois"}],
"documents": [{"name": "contrat.pdf", "base64Pdf": base64_pdf}],
},
)
envelope = r.json()
print(envelope["id"], envelope["signers"][0]["signUrl"])Envelopes
Criação, envio, acompanhamento de status, cancelamento. Um envelope pode conter vários documentos e vários signatários (paralelo ou sequencial).
Webhooks
Receba `envelope.created`, `envelope.completed`, `envelope.declined` na URL de sua escolha. HMAC SHA-256 em cada payload para verificar a origem.
Autenticação simples
Token Bearer. Uma chave por ambiente (teste / produção). Revogável instantaneamente. Limite de 100 req/min/chave, burst de 200, 429 adequado com cabeçalho Retry-After.
Endpoints disponíveis
12 rotas cobrindo o ciclo completo: envelopes, documentos, webhooks, chaves API. Todas as rotas aceitam um token Bearer e retornam JSON.
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/envelopes | List envelopes |
| POST | /api/v1/envelopes | Create + send |
| GET | /api/v1/envelopes/{id} | Fetch state |
| DELETE | /api/v1/envelopes/{id} | Void |
| POST | /api/v1/envelopes/{id}/send | Re-trigger send |
| GET | /api/v1/documents | List documents |
| GET | /api/v1/webhooks | List webhooks |
| POST | /api/v1/webhooks | Register webhook |
| DELETE | /api/v1/webhooks/{id} | Unregister |
| GET | /api/v1/keys | List API keys |
| POST | /api/v1/keys | Create API key |
| DELETE | /api/v1/keys/{id} | Revoke key |
Limites de taxa
Os limites garantem uma qualidade de serviço estável para todos os clientes. Se você precisar de mais, entre em contato conosco.
- • 100 requisições por minuto por chave API
- • Burst tolerado até 200 requisições em menos de 10s
- • Resposta 429 com cabeçalho Retry-After indicando o atraso em segundos