REST API
As chamadas servidor a servidor usam `Autorização: Bearer esk_test_…` ou `esk_live_…`. O inquilino vem da chave. O upload, o assistente de envelope e o registro webhook usam a sessão de administração.
O que uma chave API do inquilino pode chamar
| Ligar | Escopo na chave | O que você recebe de volta |
|---|---|---|
| GET /api/v1/zapier/auth/test | integrations:zapier | Seu ID e nome do locatário. Use isto para confirmar a chave. |
| GET /api/v1/zapier/triggers/{event}/sample | integrations:zapier | Exemplos de cargas úteis para document.signed, document.completed, document.expired e template.created. |
| POST /api/v1/zapier/actions/create-from-template | integrations:zapier | Um novo ID de documento de um modelo que você já possui. |
| POST /api/v1/zapier/actions/send-for-signing | integrations:zapier | O documento passa para link enviado e o signatário é enviado por e-mail. |
| POST /api/v1/signing-sessions/{sessionId}/tokens | signing:write | Um token st_… de curta duração para a incorporação. O navegador usa esse token, não a chave API. |
Sessão de administrador
Faça login no aplicativo de administração para isso. Uma chave Bearer API nessas rotas é recusada.
| Trabalho | Onde |
|---|---|
| Carregar um PDF, clientes, modelos | Documentos administrativos e clientes |
| Assistente de envelope: criar, enviar, cancelar | Envelopes administrativos |
| Registre, gire e reproduza webhooks | Admin → Desenvolvedor → Webhooks |
Confirme a chave e envie um documento modelo
Pré-requisitos: uma chave `esk_test_…` ou `esk_live_…` com `integrations:zapier` e um ID de modelo. Saída esperada: HTTP 200 do teste de autenticação, HTTP 201 com `documentId` e, em seguida, `status: "link-sent"`.
curl -sS https://api.endorsedsign.com/api/v1/zapier/auth/test \
-H "Authorization: Bearer $ENDORSED_API_KEY"
curl -sS -X POST https://api.endorsedsign.com/api/v1/zapier/actions/create-from-template \
-H "Authorization: Bearer $ENDORSED_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"templateId": "'"$ENDORSED_TEMPLATE_ID"'",
"recipientEmail": "signer@example.com",
"recipientName": "Signer Example"
}'
curl -sS -X POST https://api.endorsedsign.com/api/v1/zapier/actions/send-for-signing \
-H "Authorization: Bearer $ENDORSED_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"documentId": "'"$ENDORSED_DOCUMENT_ID"'",
"channel": "email"
}'Novas integrações devem chamar `/api/v1/…` ou `/api/v2/…`. `/api/v2` é o contrato 2026-09-01. As chamadas mutantes que o suportam devem enviar `Idempotency-Key`.
Perguntas comuns
API no espaço de trabalho do desenvolvedor locatário
Crie uma chave nomeada, atribua escopos e veja o prefixo no mesmo cromo administrativo que seus operadores já usam.
SDK guias de início rápido ao lado das credenciais ativas Os operadores
podem alternar chaves e entregar a integração SDK específica do idioma no mesmo espaço de trabalho do desenvolvedor locatário.
Espaço de trabalho do desenvolvedor com dados em tempo real
Uma única superfície de desenvolvedor mostrando controles de chave API do locatário ativo no espaço de trabalho do administrador.
Obtenha sua chave API em uma chamada
POST /api/auth/register with `mode: sandbox` returns an `esk_test_` key. Confirm it with GET /api/v1/zapier/auth/test. OpenAPI is at /api/docs.json on an API host that has docs enabled.