REST API
Server-zu-Server-Aufrufe verwenden „Authorization: Bearer esk_test_…“ oder „esk_live_…“. Der Mieter erhält den Schlüssel. Das Hochladen, der Umschlagassistent und die webhook-Registrierung nutzen die Admin-Sitzung.
Was ein Mieter mit der API-Taste aufrufen kann
| Anruf | Scope auf dem Schlüssel | Was Sie zurückbekommen |
|---|---|---|
| GET /api/v1/zapier/auth/test | integrations:zapier | Ihre Mieter-ID und Ihr Name. Bestätigen Sie hiermit den Schlüssel. |
| GET /api/v1/zapier/triggers/{event}/sample | integrations:zapier | Beispielnutzlasten für document.signed, document.completed, document.expired und template.created. |
| POST /api/v1/zapier/actions/create-from-template | integrations:zapier | Eine neue Dokument-ID aus einer Vorlage, die Sie bereits haben. |
| POST /api/v1/zapier/actions/send-for-signing | integrations:zapier | Das Dokument wird in den Status „Link gesendet“ verschoben und der Unterzeichner wird per E-Mail benachrichtigt. |
| POST /api/v1/signing-sessions/{sessionId}/tokens | signing:write | Ein kurzlebiges st_…-Token für die Einbettung. Der Browser verwendet dieses Token, nicht den API-Schlüssel. |
Administratorsitzung
Melden Sie sich hierfür in der Admin-App an. Ein Bearer-API-Schlüssel auf diesen Routen wird abgelehnt.
| Arbeit | Wo |
|---|---|
| Laden Sie ein PDF, Kunden, Vorlagen hoch | Dokumente und Kunden verwalten |
| Umschlagassistent: Erstellen, Senden, Abbrechen | Admin-Umschläge |
| Registrieren, drehen und spielen Sie webhooks ab | Admin → Entwickler → Webhooks |
Bestätigen Sie den Schlüssel und senden Sie dann ein Vorlagendokument
Voraussetzungen: ein „esk_test_…“- oder „esk_live_…“-Schlüssel mit „integrations:zapier“ und eine Vorlagen-ID. Erwartete Ausgabe: HTTP 200 vom Authentifizierungstest, HTTP 201 mit „documentId“, dann „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"
}'Neue Integrationen sollten „/api/v1/…“ oder „/api/v2/…“ aufrufen. „/api/v2“ ist der Vertrag vom 01.09.2026. Mutierende Aufrufe, die dies unterstützen, sollten „Idempotency-Key“ senden.
Häufige Fragen
API-Schlüssel im Arbeitsbereich des Mandantenentwicklers
Erstellen Sie einen benannten Schlüssel, weisen Sie Bereiche zu und sehen Sie sich das Präfix im selben Admin-Chrome an, den Ihre Operatoren bereits verwenden.
SDK Schnellstarts neben aktiven Anmeldeinformationen
Operatoren können Schlüssel rotieren und sprachspezifisches SDK Onboarding über denselben Mandantenentwicklerarbeitsbereich übergeben.
Entwicklerarbeitsbereich mit Live-Daten
Eine einzelne Entwickleroberfläche, die die wichtigsten Steuerelemente des aktiven Mandanten API im Admin-Arbeitsbereich anzeigt.
Holen Sie sich Ihren API-Schlüssel in einem Anruf
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.