إنستاسبيس
واجهة برمجة التطبيقات

الأخطاء والحدود

رموز الحالة، وحدود المعدّل، والحصة الشهرية لطلبات التوقيع في كل خطة.

استجابات الأخطاء

تستخدم الأخطاء رموز حالة HTTP المعتادة مع جسم JSON يصف المشكلة:

الحالةمتى تحدث
400فشل جسم الطلب في التحقّق — دور مفقود، أو حقل غير معروف في values، أو بريد إلكتروني بصيغة خاطئة. وتسرد الرسالة ما ينبغي إصلاحه.
401لا يوجد مفتاح واجهة، أو المفتاح غير صالح أو مُبطَل أو منتهي الصلاحية.
403المفتاح يعمل لكن الإجراء غير مسموح — الخطة لم تعد تشمل التوقيع الإلكتروني، أو غادر منشئ المفتاح مساحة العمل، أو استُنفدت الحصة الشهرية (limit_reached:signatureRequests).
404معرّف غير معروف — بما في ذلك القوالب الموجودة لكن غير المنشورة.
429تجاوز حدّ المعدّل.

حدّ المعدّل

تخضع الطلبات لحدّ معدّل لكل عميل قدره 120 طلبًا في الدقيقة. وبعد ذلك تعيد الطلبات 429 حتى تنقضي نافذة الدقيقة. وإن كنت تستطلع حالة عدد كبير من طلبات التوقيع، فوزّع الاستطلاعات بدل إرسالها دفعةً واحدة.

الحصة الشهرية لطلبات التوقيع

إرسال طلب توقيع — من التطبيق أو عبر الواجهة — يُحتسَب من الحصة الشهرية لمساحة عملك، وهي تُجدَّد في بداية كل شهر ميلادي (بتوقيت UTC):

الخطةطلبات التوقيع / الشهر
المبتدئة1
الاحترافية10
Max25
فريق قياسية50 (لمساحة العمل كاملة)
فريق مميّزة100 (لمساحة العمل كاملة)
المؤسساتغير محدودة

وحين تُستنفَد الحصة، يعيد POST /esign/submissions رمز 403 مع الرمز الثابت limit_reached:signatureRequests. أما سرد القوالب واستطلاع الحالة وتنزيل المستندات الموقّعة فلا تُحتسَب أبدًا، والطلب المعاد بمفتاح idempotencyKey مستخدَم سابقًا لا يُحتسَب مرة أخرى.

توليد مستند مملوء دون إرساله للتوقيع (وهو متاح في التطبيق) لا يُحتسَب من الحصة كذلك — فطلبات التوقيع وحدها هي التي تُحتسَب.

في هذه الصفحة