מפתחים

התחלה מהירה - התקשר ל- API מהשרת שלך

תבע ארגז חול, אחסן את מפתח `esk_test_`, אשר אותו, צור מסמך מתבנית ושלח אותו. אסימוני סשן חתימה משתמשים באותו מפתח. Webhooks רשומים באפליקציית הניהול.

לפני שתתחיל

אתה צריך טרמינל עם ''curl'' ו-''jq'', בתוספת תיבת דואר אלקטרוני שאתה שולט בו. מפתח ארגז החול הוא `esk_test_…`. מפתח ייצור הוא `esk_live_…`. שלח אותו בתור `הרשאה: נושאת`. השוכר מגיע מהמפתח, אז אל תשלחו `x-tenant-id`.

מפתח ארגז חול כולל ''integrations:zapier'' ו-''signing:write''. העלאה, אשף המעטפות ורישום webhook משתמשים בהפעלת הניהול לאחר הכניסה. השרת שלך משתמש במפתח עבור השיחות למטה.

ארבע שיחות שרת, ואז webhook באפליקציית הניהול

  1. 1

    תבע את ארגז החול שלך

    POST /api/auth/register with `mode: sandbox`. The response includes a full `esk_test_…` key, shown once, plus `demoCustomerId`. When seeding succeeds it also includes `sampleTemplateId`.

  2. 2

    אשר את המפתח

    GET /api/v1/zapier/auth/test with the key. Expected output: HTTP 200 and `{ success: true, data: { tenantId, tenantName, zapierEnabled: true } }`.

  3. 3

    צור מסמך ושלח אותו

    POST /api/v1/zapier/actions/create-from-template with `sampleTemplateId`, then POST /api/v1/zapier/actions/send-for-signing with the returned `documentId`. The signer receives the link by email.

  4. 4

    רשם webhook ב-Admin

    היכנס ופתח את Admin → Developer → Webhooks. שמור את סוד החתימה. משלוחים משתמשים ב-`X-Endorsed-Signature`. שלבי האימות נמצאים במדריך של webhook. בדוק ניסיונות בניהול ← מפתח ← מסוף.

שלב 1 - תבע ארגז חול

דרישות מוקדמות: כתובת דואר אלקטרוני וסיסמה של 8+ תווים. פלט צפוי: HTTP 201 עם `data.sandbox.apiKey` שמתחיל את `esk_test_`.

bash
curl -sS -X POST https://api.endorsedsign.com/api/auth/register \
  -H 'Content-Type: application/json' \
  -d '{
    "tenantName": "Acme Dev Sandbox",
    "adminEmail": "you@acme.example",
    "password": "your-strong-password",
    "mode": "sandbox"
  }' | tee sandbox.json | jq '.data.sandbox'

# → {
#     "apiKey": "esk_test_…",
#     "keyPrefix": "esk_test_…",
#     "keyId": "…",
#     "scopes": ["signing:write", "integrations:zapier", …],
#     "demoCustomerId": "sandbox-signer-acme-dev-sandbox",
#     "demoCustomerName": "Sandbox Signer",
#     "sampleTemplateId": "…",
#     "expiresAt": "2026-…"
#   }

export ENDORSED_API_KEY="$(jq -r '.data.sandbox.apiKey' sandbox.json)"
export ENDORSED_TEMPLATE_ID="$(jq -r '.data.sandbox.sampleTemplateId // empty' sandbox.json)"

אחסן את המפתח במנהל סוד השרת שלך. אימות דוא"ל משער את מסוף הניהול. המפתח פועל עבור השיחות בדף זה ברגע שהוא מונפק.

שלב 2 - אשר את המפתח

דרישות מוקדמות: `$ENDORSED_API_KEY` משלב 1. למפתח ארגז החול יש כבר `integrations:zapier`. פלט צפוי: HTTP 200 ושם הדייר שלך.

bash
curl -sS https://api.endorsedsign.com/api/v1/zapier/auth/test \
  -H "Authorization: Bearer $ENDORSED_API_KEY" \
  | jq '{ success, tenantId: .data.tenantId, tenantName: .data.tenantName, zapierEnabled: .data.zapierEnabled }'

מפתח חסר או פגום הוא 401. מפתח חוקי ללא `integrations:zapier` הוא 403. אל תשלח `X-Data-Mode`: `esk_test_` כבר בוחר נתוני בדיקה.

שלב 3 - צור מסמך מתבנית ארגז החול ושלח אותו

דרישות מוקדמות: `$ENDORSED_API_KEY` ו-`$ENDORSED_TEMPLATE_ID` לא ריק. אם ''sampleTemplateId'' היה null, צור תבנית באפליקציית הניהול והדבק את המזהה שלה. פלט צפוי: HTTP 201 עם `data.documentId`, ולאחר מכן תגובת שליחה עם `סטטוס: "נשלח קישור"`.

bash
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\": \"you@acme.example\",
    \"recipientName\": \"Sandbox Signer\"
  }" | tee created.json | jq '.data | { documentId, customerId, status }'

export ENDORSED_DOCUMENT_ID="$(jq -r '.data.documentId' created.json)"

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\",
    \"subject\": \"Please sign\"
  }" | jq '.data | { documentId, status, channel, shareLinkExpiresAt }'

קישור החתימה נשלח באימייל אל `recipientEmail`. תגובת ה-JSON נושאת את מזהה המסמך, הסטטוס ותפוגה של הקישור. פתח את האימייל כדי לסיים את החתימה, ואז צפה ב-''document.signed'' ב-webhook שרשמת ב-Admin.

טביעו אסימון של מפגש חתימה

דרישות מוקדמות: `$ENDORSED_API_KEY` עם `signing:write` (כלול במפתח ארגז החול) ומזהה הפעלת חתימה מהפעלה שכבר יצרת. פלט צפוי: HTTP 201 עם אסימון ''st_…'' חד פעמי.

bash
curl -sS -X POST "https://api.endorsedsign.com/api/v1/signing-sessions/$ENDORSED_SESSION_ID/tokens" \
  -H "Authorization: Bearer $ENDORSED_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{ "scope": "embed", "ttl_seconds": 300 }' \
  | jq '{ token, expires_at, scope }'

העבר את ''st_…'' להטמעת הדפדפן. השאר את ''esk_...'' בשרת. הוראות מימוש נמצאות בדף ההטמעה של אלמנטים.

כשמשהו משתבש

מוכנים להעמיק?

ברגע שיש לך מסמך חתום מקצה לקצה, חבר לאזורי הפנים למטה לפרוסה הבאה של האינטגרציה.

REST API התייחסותWebhook חוזה + חתימות