REST API
קריאות שרת לשרת משתמשות ב-`Authorization: Bearer esk_test_…` או `esk_live_…`. השוכר מגיע מהמפתח. העלאה, אשף המעטפות והרשמה webhook משתמשים בהפעלת הניהול.
מה יכול להתקשר למקש דייר API
| התקשר | סקופ על המפתח | מה אתה מקבל בחזרה |
|---|---|---|
| GET /api/v1/zapier/auth/test | integrations:zapier | מזהה הדייר והשם שלך. השתמש בזה כדי לאשר את המפתח. |
| GET /api/v1/zapier/triggers/{event}/sample | integrations:zapier | מטענים לדוגמה עבור document.signed, document.completed, document.expired ו-template.created. |
| POST /api/v1/zapier/actions/create-from-template | integrations:zapier | מזהה מסמך חדש מתבנית שכבר יש לך. |
| POST /api/v1/zapier/actions/send-for-signing | integrations:zapier | המסמך עובר לקישור שנשלח והחותם נשלח בדוא"ל. |
| POST /api/v1/signing-sessions/{sessionId}/tokens | signing:write | אסימון st_… קצר מועד להטמעה. הדפדפן משתמש באסימון הזה, לא במקש API. |
הפעלת ניהול
היכנס לאפליקציית הניהול עבור אלה. מקש נושא API במסלולים אלה מסורבים.
| עבודה | איפה |
|---|---|
| העלה PDF, לקוחות, תבניות | מסמכי מנהל ולקוחות |
| אשף מעטפות: צור, שלח, בטל | מעטפות אדמין |
| הרשמה, סובב והפעל מחדש webhooks | אדמין → מפתח → Webhooks |
אשר את המפתח ולאחר מכן שלח מסמך תבנית
דרישות מוקדמות: מפתח `esk_test_…` או `esk_live_…` עם `integrations:zapier` ומזהה תבנית. פלט צפוי: HTTP 200 מבדיקת האישור, HTTP 201 עם `documentId` ולאחר מכן `סטטוס: "נשלח קישור"`.
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"
}'אינטגרציות חדשות צריכות לקרוא `/api/v1/…` או `/api/v2/…`. `/api/v2` הוא חוזה 2026-09-01. שיחות המוטות שתומכות בו צריכות לשלוח ''Idempotency-Key''.
שאלות נפוצות
API בסביבת העבודה של מפתח הדיירים
צור מפתח עם שם, הקצה טווחים וראה את הקידומת באותו כרום אדמין שהמפעילים שלך כבר משתמשים בהם. מפתחות

SDK לצד אישורים פעילים
מפעילים יכולים לסובב מקשים ולמסור SDK הצטרפות לשפה ספציפית מאותו סביבת עבודה של מפתח דייר. התחלה מהירה של

סביבת עבודה למפתחים עם נתונים חיים
משטח מפתח יחיד המציג בקרות מפתח של דייר API בסביבת העבודה של הניהול. רשימת מפתחות

קבל את מפתח API בשיחה אחת
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.