الراحة API
تستخدم مكالمات خادم إلى خادم `التفويض: Bearer esk_test_...` أو `esk_live_...`. المستأجر يأتي من المفتاح. يستخدم التحميل ومعالج المغلف وتسجيل webhook جلسة الإدارة.
ما الذي يمكن للمستأجر API الاتصال به
| اتصل على | النطاق على المفتاح | ما ستعود به |
|---|---|---|
| GET /api/v1/zapier/auth/test | integrations:zapier | معرف المستأجر الخاص بك واسمك. استخدم هذا لتأكيد المفتاح. |
| GET /api/v1/zapier/triggers/{event}/sample | integrations:zapier | نموذج الحمولات للمستندات الموقعة والمكتملة والمستند منتهية الصلاحية والقالب الذي تم إنشاؤه. |
| 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_...` مع `التكاملات:zapier`، ومعرف القالب. المخرجات المتوقعة: HTTP 200 من اختبار المصادقة، HTTP 201 مع `documentId`، ثم `الحالة: "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"
}'يجب أن تستدعي عمليات التكامل الجديدة `/api/v1/...` أو `/api/v2/...`. `/api/v2` هو عقد 01-09-2026. يجب أن ترسل المكالمات المتغيرة التي تدعمها "مفتاح Idempotency".
الأسئلة الشائعة
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.