الانتقال إلى المحتوى

واجهة برمجة التطبيقات للمطورين · آخر تحديث

أدخل التوقيع إلى منتجك الخاص.

أنشئ مستندات من ملف PDF أو Word أو من قالب، وأرسلها للتوقيع، وتابع حالتها، واستقبل إشعارات webhook عند توقيعها، كل ذلك من شيفرتك البرمجية.

واجهة REST API

إشعارات Webhook

مفاتيح API

هل واجهة eSignSimple البرمجية متاحة الآن؟

يمكن لبرنامجك الآن إنشاء المستندات وإرسالها للتوقيع ومتابعة حالتها وتنزيل النسخ الموقّعة دون أن يسجّل أحد الدخول إلى لوحة التحكم. تعمل واجهة REST API على العنوان https://esignsimple.com/api/v1، والمرجع الكامل مع أمثلة الطلبات والاستجابات موجود في صفحة المطورين.

يحصل الموقّعون الذين تصلهم المستندات عبر الواجهة البرمجية على تجربة التوقيع نفسها بلا حساب، وعلى الأدلة نفسها كما في المستندات المرسلة من لوحة التحكم: سجل تدقيق وشهادة إتمام وبصمة SHA-256 يمكن لأي شخص فحصها في صفحة التحقق العامة لدينا.

كيف تعمل الواجهة البرمجية؟

أنشئ مستندًا عبر POST /documents. ترسل طلبًا متعدد الأجزاء (multipart) يضم ملف PDF وجزءًا بصيغة JSON يسرد الموقّعين والحقول، وتُحدَّد مواضع الحقول كنِسَب من الصفحة، فلا داعي للاهتمام بنقاط PDF أو أحجام الصفحات. يُرسَل المستند فورًا، أو يُحفظ مسودةً إذا مرّرت send:false.

لديك قالب في لوحة التحكم بالفعل؟ يملأ POST /templates/{id}/send الموقّعين ويرسله. ويسرد GET /documents مستنداتك مع مرشّح للحالة وترقيم صفحات بالمؤشر عبر before. ويعيد GET /documents/{id} الحالة والموقّعين وسجل التدقيق كاملًا، ويعيد GET /documents/{id}/download ملف PDF الموقّع بعد اكتمال المستند، أو الأصل مع ?file=original.

ويمكنك أيضًا إلغاء مستند قيد التنفيذ عبر POST /documents/{id}/void، وحذف مستند عبر DELETE /documents/{id}، ومعرفة خطتك واستهلاكك الحالي عبر GET /me.

كيف تعمل المصادقة ومفاتيح API؟

يستخدم كل طلب مفتاح API من نوع Bearer. تنشئ المفاتيح وتلغيها من الإعدادات ← المطورون. يُعرض المفتاح مرة واحدة عند إنشائه ولا نخزّن إلا قيمة مجزّأة (hash) منه، فانسخه إلى مدير الأسرار لديك فورًا. وإذا تسرّب مفتاح، فألغِه وأنشئ مفتاحًا جديدًا؛ ولا يلزم تغيير أي شيء آخر.

وتقبل الواجهة نفسها أيضًا رموز Firebase ID، وهي ما سيستخدمه تطبيقنا المحمول القادم. وهذا خيار مقصود: نحن نبني تطبيقاتنا على الواجهة العامة نفسها التي تستخدمها، فتُختبر كل يوم.

ما إشعارات webhook التي يمكنك استقبالها؟

بدلًا من الاستعلام المتكرر، سجّل نقطة نهاية HTTPS واحدة لحسابك وسنُعلمها عند حدوث أي شيء. الأحداث هي document.completed وdocument.declined وdocument.voided وsigner.signed.

كل إشعار موقّع بخوارزمية HMAC-SHA256، ويُرسل التوقيع في الترويسة esign-signature، لتتأكد من أن الطلب صادر منا فعلًا قبل التصرف بناءً عليه. وإذا فشلت نقطة النهاية لديك، نعيد المحاولة مرة واحدة. نصيحتنا: تعامل مع webhook كمحفّز، واستدعِ GET /documents/{id} للحصول على الحالة المعتمدة.

ماذا يبني الناس بالواجهة البرمجية؟

نظام إدارة علاقات العملاء أو أداة عروض أسعار ترسل العقد لحظة تحديد الصفقة كصفقة رابحة. ونظام موارد بشرية يرسل حزمة التهيئة من قالب عند تأكيد التعيين. وأداة عقارية ترسل عقد الإيجار وتحفظ ملف PDF الموقّع في سجل الوحدة عند وصول document.completed. وبرنامج نصي داخلي يغني عن نسخ الصفوف من جدول بيانات إلى العقود يدويًا.

إذا كنت ترسل بضعة مستندات أسبوعيًا، فغالبًا لا تحتاج إلى الواجهة البرمجية أصلًا. فـالقوالب والإرسال الجماعي ونماذج الويب في لوحة التحكم ستكفيك بجهد أقل بكثير.

كيف تُسعَّر الواجهة البرمجية؟

لا توجد خطة منفصلة للواجهة البرمجية. تنطبق حدود الخطة نفسها كما في تطبيق الويب: تشمل الخطة المجانية 5 مستندات شهريًا، والخطة الشخصية بلا حدود (راجع الأسعار). والمستندات المنشأة عبر الواجهة البرمجية تُحتسب تمامًا كالمستندات المرسلة من لوحة التحكم.

أما المزوّدون الكبار مثل DocuSign وDropbox Sign وAdobe فيسعّرون واجهاتهم البرمجية عادةً بمعزل عن خطط المستخدمين، وغالبًا بناءً على أحجام المظاريف السنوية، وقد تكلّف خطط الواجهة البرمجية المبدئية أكثر بكثير من اشتراكاتهم العادية. راجع مواقعهم للاطلاع على الأسعار الحالية.

ما الذي لم يُضمَّن بعد؟

نحن صريحون بشأن النواقص. لا يوجد بعد إطار iframe للتوقيع المضمّن، فلا يزال الموقّعون يوقّعون عبر الرابط الذي نرسله إليهم بالبريد الإلكتروني. ولا توجد حزم SDK رسمية؛ فالواجهة البرمجية مجرد HTTP وJSON، وأي لغة برمجة فيها عميل HTTP تعمل معها. ولا توجد بيئة اختبار (sandbox) منفصلة، لذا اختبر بحساب مجاني وعناوين بريدك الإلكتروني. وكل ذلك ضمن خارطة طريقنا.

لماذا بدأنا بواجهة برمجية صغيرة؟

بدأنا بنطاق ضيق عن قصد. فالواجهة الصغيرة التي تنجز سير العمل الشائع جيدًا، بحدود متوقعة ودون مكالمة مبيعات، أنفع من واجهة ضخمة يستغرق دمجها أسابيع. وإذا كان ينقصك شيء، فأخبرنا بما تبنيه؛ فالتكاملات الحقيقية هي ما يحدد ما نضيفه بعد ذلك.

ما نقاط النهاية المتاحة في الواجهة البرمجية اليوم؟

نقطة النهايةما تفعلهالاستخدام المعتاد
POST /documentsرفع ملف PDF مع الموقّعين والحقول، ثم الإرسال أو الحفظ مسودةإرسال عقد مُولَّد من تطبيقك
POST /templates/{id}/sendإرسال قالب من لوحة التحكم إلى موقّعين محددينحزمة التهيئة عند تأكيد التعيين
GET /documents و GET /documents/{id}سرد المستندات أو قراءة الحالة والموقّعين وسجل التدقيقمزامنة الحالة مع نظام إدارة علاقات العملاء
GET /documents/{id}/downloadتنزيل ملف PDF الموقّع (أو الأصل)حفظ النسخة الموقّعة في السجل المعني
POST /documents/{id}/void و DELETE /documents/{id}إلغاء مستند أو حذفهسحب عرض أو تنظيف المسودات
GET /meالخطة والاستهلاك هذا الشهرالتنبيه قبل بلوغ حد الخطة المجانية

الأسئلة الشائعة

هل لدى eSignSimple واجهة برمجية؟

نعم. واجهة REST API متاحة على https://esignsimple.com/api/v1 مع مفاتيح API من نوع Bearer وإشعارات webhook. والمرجع موجود في صفحة المطورين.

كم تكلّف الواجهة البرمجية؟

لا يوجد تسعير منفصل للواجهة البرمجية. تنطبق خطتك العادية: الخطة المجانية تشمل 5 مستندات شهريًا، والخطة الشخصية بلا حدود.

كيف أحصل على مفتاح API؟

أنشئه من الإعدادات ← المطورون. يُعرض مرة واحدة ويُخزَّن مجزّأً (hash)، فاحفظه فورًا. ويمكنك إلغاء المفاتيح في أي وقت.

ما أحداث webhook المتاحة؟

document.completed وdocument.declined وdocument.voided وsigner.signed، موقّعة بخوارزمية HMAC-SHA256 في الترويسة esign-signature، مع إعادة محاولة واحدة.

هل تدعمون التوقيع المضمّن أو حزم SDK أو بيئة اختبار؟

ليس بعد. الثلاثة كلها ضمن خارطة طريقنا. اليوم يوقّع الموقّعون عبر رابط يصلهم بالبريد الإلكتروني، وتستدعي أنت الواجهة البرمجية عبر HTTP عادي.

قراءات ذات صلة

احصل على توقيع مستندك التالي اليوم.

5 مستندات مجانية شهريًا للبدء. لا حاجة إلى بطاقة ائتمان.