RUST API
Server-naar-server-oproepen gebruiken `Authorisatie: Bearer esk_test_…` of `esk_live_…`. De huurder komt van de sleutel. Uploaden, de envelopwizard en webhook-registratie gebruiken de beheerderssessie.
Wat een huurder API-sleutel kan oproepen
| Bel | Reikwijdte op de sleutel | Wat je terugkrijgt |
|---|---|---|
| GET /api/v1/zapier/auth/test | integrations:zapier | Uw huurder-ID en naam. Gebruik dit om de sleutel te bevestigen. |
| GET /api/v1/zapier/triggers/{event}/sample | integrations:zapier | Voorbeeldpayloads voor document.signed, document.completed, document.expired en template.created. |
| POST /api/v1/zapier/actions/create-from-template | integrations:zapier | Een nieuw document-ID van een sjabloon dat u al heeft. |
| POST /api/v1/zapier/actions/send-for-signing | integrations:zapier | Het document wordt verplaatst naar link verzonden en de ondertekenaar ontvangt een e-mail. |
| POST /api/v1/signing-sessions/{sessionId}/tokens | signing:write | Een kortstondige st_… token voor de insluiting. De browser gebruikt dat token, niet de API-sleutel. |
Beheersessie
Log hiervoor in op de beheerdersapp. Een Bearer API sleutel op deze routes wordt geweigerd.
| Werk | Waar |
|---|---|
| Upload een PDF, klanten, sjablonen | Admin documenten en klanten |
| Envelopwizard: aanmaken, verzenden, annuleren | Admin-enveloppen |
| Registreer, roteer en speel webhook''s opnieuw | Beheerder → Ontwikkelaar → Webhook''s |
Bevestig de sleutel en verzend vervolgens een sjabloondocument
Vereisten: een `esk_test_…` of `esk_live_…` sleutel met `integrations:zapier`, en een sjabloon-ID. Verwachte uitvoer: HTTP 200 van de auth-test, HTTP 201 met `documentId` en vervolgens `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"
}'Nieuwe integraties moeten `/api/v1/…` of `/api/v2/…` aanroepen. `/api/v2` is het contract van 01-09-2026. Muterende aanroepen die dit ondersteunen, moeten ''Idempotency-Key'' verzenden.
Veelgestelde vragen
API sleutels in de werkruimte van de tenantontwikkelaar
Maak een benoemde sleutel, wijs scopes toe en bekijk het voorvoegsel in dezelfde admin-chrome die uw operators al gebruiken.
SDK quickstarts naast actieve inloggegevens
Operators kunnen sleutels roteren en taalspecifieke SDK-onboarding overdragen vanuit dezelfde werkruimte van de tenantontwikkelaar.
Werkruimte voor ontwikkelaars met live data
Een enkel ontwikkelaarsoppervlak waarop de belangrijkste bedieningselementen van de actieve tenant API worden weergegeven in de beheerderswerkruimte.
Ontvang uw API sleutel in één gesprek
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.