code التي يمكنك الاعتماد عليها في التفرع، والإخفاقات التي يمكن إعادة محاولتها بأمان.
اعتمد على الحالة أولاً، وعلى code عند وجوده، لأن نص الرسالة قد يتغير.
رموز الحالة
أجسام الأخطاء
لا تشترك أجسام الأخطاء في بنية واحدة، لذا اقرأها بحذر. يختلف الشكل حسب عائلة الـendpoint:
قد لا يحمل
500 أي جسم JSON على الإطلاق، لذا عالج الجسم الذي لا يمكن تحليله.
أخطاء مفتاح API
لبضع دقائق بعد حذف التطبيق تُجيب الواجهة بالرمز
application_deleted، وبعد ذلك ترفض المفتاح كأي مفتاح خاطئ.
لا تُعِد المحاولة: التطبيق ومفاتيحه لم تعد موجودة.
راجع مصادقة API ومفاتيح API لمعرفة كيفية عمل المفاتيح وحدودها.
الرصيد غير كافٍ
تُبلغ كل عائلة واجهات عن الرصيد المنخفض بطريقتها الخاصة:
في حالة وجود عقد، يُجيب إنشاء الجلسة بالحالة
403 مع "code": "contract_billing_suspended" طالما أن الخدمات المدفوعة متوقفة لمؤسستك.
لا تُحتسب الرسوم على تطبيقات البيئة التجريبية أبداً، لذا تتخطى هذه الفحوص.
رموز الأخطاء
قيمcode هذه ثابتة، لذلك يمكنك بناء منطق التفرع عليها.
تظهر معظمها بجانب detail؛ وفي التحقق من محفظة الهوية الرقمية، تكون القيمة هي قيمة error.
الوصول والفوترة
الطلبات وidempotency
فحوصات البنوك والهاتف والمخاطر
التحقق من الشركات (KYB)
محافظ الهوية الرقمية
التقارير والحالات
التوقيع الإلكتروني
عند إنشاء جلسة، تظهر مشكلات المستند أدناه كقيمة للحقل المعني مع الحالة
400، على سبيل المثال: {"sign": "signature_document_changed"}:
webhook
إعادة المحاولة وidempotency
بعض الأخطاء يمكن تكرار الطلب بعدها بأمان، وبعضها لا يمكن:429: انتظر القيمة الموجودة في الرأسRetry-After، ثم أعد المحاولة.502و503: أعد المحاولة مع التراجع التدريجي (backoff) عندما ينص مرجع endpoint على أنه لم يُحتسب أي رسوم، كما هو الحال في فحوصات الهاتف والبريد الإلكتروني والمصرفية وفحوصات المخاطر.502علىPOST /v3/database-validation/: اقرأ كل عنصر فيvalidation_errorsأولاً، لأن هذه الحالة وحدها لا تعني فشلاً مؤقتاً.503عند الحذف: كرر الطلب نفسه حتى يُرجع200.4xxالأخرى: أصلح الطلب أولاً، لأن الطلب نفسه سيفشل بالطريقة نفسها.
POST /v3/aml/ والتحقق من محفظة الهوية الرقمية الرأس Idempotency-Key بطول يصل إلى 255 حرفاً.
تكرار الطلب بالمفتاح نفسه والمحتوى نفسه يعيد الاستجابة المخزنة، فتُنفَّذ العملية وتُحتسب الرسوم مرة واحدة فقط.
المفتاح نفسه مع محتوى مختلف يُرجع 409، وأثناء تشغيل الطلب الأول تُرجع endpoints المحفظة 409 مع Retry-After.
لا تملك POST /v3/session/ مفتاح idempotency، لذلك إذا انتهت مهلة إنشاء جلسة، فاستعرض جلساتك باستخدام vendor_data قبل أن تنشئ جلسة أخرى.
ذات صلة
- تحديد المعدل: الحدود والرؤوس وجسم استجابة
429. - مصادقة API: كيفية إرسال مفتاحك.
- اختبار البيئة التجريبية: أعد إنتاج النتائج دون بيانات حقيقية أو فوترة.
- Webhooks: التسليم وإعادة المحاولات والترتيب.