RESTO API
Le chiamate da server a server utilizzano `Autorizzazione: Bearer esk_test_…` o `esk_live_…`. L''inquilino viene dalla chiave. Il caricamento, la procedura guidata della busta e la registrazione webhook utilizzano la sessione di amministrazione.
Ciò che può chiamare un tasto API dell''inquilino
| Chiama | Ambito sulla chiave | Cosa ottieni indietro |
|---|---|---|
| GET /api/v1/zapier/auth/test | integrations:zapier | ID e nome dell''inquilino. Usalo per confermare la chiave. |
| GET /api/v1/zapier/triggers/{event}/sample | integrations:zapier | Payload di esempio per document.signed, document.completed, document.expired e template.created. |
| POST /api/v1/zapier/actions/create-from-template | integrations:zapier | Un nuovo ID documento da un modello che già possiedi. |
| POST /api/v1/zapier/actions/send-for-signing | integrations:zapier | Il documento viene spostato in link-sent e il firmatario riceve un''e-mail. |
| POST /api/v1/signing-sessions/{sessionId}/tokens | signing:write | Un token st_… di breve durata per l''incorporamento. Il browser utilizza quel token, non la chiave API. |
Sessione amministrativa
Accedi all''app di amministrazione per questi. Una chiave al portatore API su queste rotte viene rifiutata.
| Lavoro | Dove |
|---|---|
| Carica un PDF, clienti, modelli | Documenti amministrativi e clienti |
| Procedura guidata busta: crea, invia, annulla | Buste amministrative |
| Registra, ruota e riproduci webhooks | Amministratore → Sviluppatore → Webhooks |
Conferma la chiave, quindi invia un documento modello
Prerequisiti: una chiave `esk_test_…` o `esk_live_…` con `integrations:zapier` e un ID modello. Output previsto: HTTP 200 dal test di autenticazione, HTTP 201 con `documentId`, quindi `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"
}'Le nuove integrazioni dovrebbero chiamare `/api/v1/…` o `/api/v2/…`. "/api/v2" è il contratto del 01-09-2026. Le chiamate mutanti che lo supportano dovrebbero inviare "Idempotency-Key".
Domande comuni
API nell''area di lavoro dello sviluppatore tenant
Crea una chiave denominata, assegna ambiti e visualizza il prefisso nello stesso chrome di amministrazione già utilizzato dai tuoi operatori.
SDK avvio rapido accanto alle credenziali attive
Gli operatori possono ruotare le chiavi e trasferire l''onboarding SDK specifico della lingua dallo stesso spazio di lavoro dello sviluppatore tenant.
Area di lavoro per sviluppatori con dati in tempo reale
Una singola superficie per sviluppatori che mostra i controlli chiave del tenant attivo API nell''area di lavoro di amministrazione. Elenco chiavi
Ottieni la tua chiave API in una sola chiamata
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.