ODPOWIEDŹ API
Wywołania serwer-serwer używają `Autoryzacji: Bearer esk_test_…` lub `esk_live_…`. Najemca pochodzi od klucza. Przesyłanie, kreator kopert i rejestracja webhook korzystają z sesji administratora.
Co może wywołać klucz API najemcy
| Zadzwoń | Lunet na klawiszu | Co otrzymasz w zamian |
|---|---|---|
| GET /api/v1/zapier/auth/test | integrations:zapier | Identyfikator i imię i nazwisko Twojego najemcy. Użyj tego, aby potwierdzić klucz. |
| GET /api/v1/zapier/triggers/{event}/sample | integrations:zapier | Przykładowe ładunki dla dokumentu.podpisany, dokument.ukończony, dokument.wygasły i utworzony szablon. |
| POST /api/v1/zapier/actions/create-from-template | integrations:zapier | Nowy identyfikator dokumentu z szablonu, który już posiadasz. |
| POST /api/v1/zapier/actions/send-for-signing | integrations:zapier | Dokument zostanie przeniesiony do łącza wysłanego, a osoba podpisująca zostanie wysłana e-mailem. |
| POST /api/v1/signing-sessions/{sessionId}/tokens | signing:write | Krótkotrwały token st_… do osadzenia. Przeglądarka używa tego tokena, a nie klucza API. |
Sesja administratora
Zaloguj się do aplikacji administracyjnej, aby je uzyskać. Klucz na okaziciela API na tych trasach jest odrzucany.
| Praca | Gdzie |
|---|---|
| Prześlij PDF, klientów i szablony | Administrowanie dokumentami i klientami |
| Kreator kopert: utwórz, wyślij, anuluj | Koperty administracyjne |
| Zarejestruj się, obracaj i odtwarzaj ponownie webhook | Administrator → Programista → Webhooks |
Potwierdź klucz, a następnie wyślij dokument szablonowy
Wymagania: klucz `esk_test_…` lub `esk_live_…` z `integrations:zapier` i identyfikator szablonu. Oczekiwany wynik: HTTP 200 z testu uwierzytelniania, HTTP 201 z `documentId`, następnie `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"
}'Nowe integracje powinny wywoływać `/api/v1/…` lub `/api/v2/…`. `/api/v2` to kontrakt 2026-09-01. Mutowanie wywołań, które go obsługują, powinno wysłać `Idempotency-Key`.
Częste pytania
API w obszarze roboczym dewelopera dzierżawy
Utwórz nazwany klucz, przypisz zakresy i zobacz prefiks w tym samym panelu administracyjnym, którego używają już Twoi operatorzy.
SDK przewodniki szybkiego startu obok aktywnych poświadczeń
Operatorzy mogą zmieniać klucze i przekazywać wdrożenie SDK specyficzne dla języka z tego samego obszaru roboczego programisty dzierżawy. Przewodniki szybkiego startu
Przestrzeń robocza programisty z bieżącymi danymi
Pojedyncza powierzchnia programisty pokazująca kluczowe elementy sterujące aktywnego najemcy API w obszarze roboczym administratora.
Odbierz klucz API podczas jednej rozmowy
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.