معالجة الأخطاء والحصص وإعادة المحاولة
يستخدم كل فشل في API صيغة JSON ويتضمن معرّف طلب آمناً للدعم. اتخذ القرار من
حالة HTTP وerror.code الثابت، لا من نص الرسالة المترجم.
{ "error": { "code": "student_not_found", "message": "Student not found", "request_id": "req_example", "details": null }}فئات الحالات
Section titled “فئات الحالات”| الحالة | المعنى | إجراء العميل |
|---|---|---|
400 | استعلام غير صحيح أو JSON مشوه أو ترويسة منع تكرار غير صحيحة | صحح الطلب |
401 | بيانات اعتماد غائبة أو غير صحيحة | توقف وأصلح المفتاح أو استبدله |
403 | رفض نطاق أو إطلاق أو ميزة أو تعليق أو شبكة أو سياسة | احصل على ضبط مخول |
404 | مسار أو مورد آمن للمستأجر غير موجود | تحقق من المسار والمعرّف المحلي |
409 | تعارض دورة حياة أو منع تكرار | افحص الرمز، ولا تعِد إلا إذا وُثق |
413 | الجسم أكبر من 1 MiB | صغّر الطلب |
415 | نوع وسائط غير مدعوم | أرسل JSON |
422 | JSON صحيح وحقول عمل غير صحيحة | صحح البيانات |
429 | بلوغ حد الاندفاع أو الحصة اليومية | احترم Retry-After |
500 | فشل خادم غير متوقع | أعد بحذر وأبلغ معرّف الطلب |
503 | API أو السياسة أو الحصة أو خدمة مطلوبة غير متاحة | تراجع وأعد لاحقاً |
لا تستخدم 404 لاستنتاج انتماء معرّف إلى مدرسة أخرى.
ترويسات حد الطلبات
Section titled “ترويسات حد الطلبات”تتضمن الاستجابات بعد تقييم الحصة:
X-RateLimit-LimitX-RateLimit-RemainingX-RateLimit-Reset
إعادة الضبط عند منتصف الليل التالي UTC كوقت Unix. وتعني -1 للحد والمتبقي
غير محدود، مع إمكان استمرار قياس الاستخدام. تتضمن 429 ترويسة
Retry-After. الافتراض الحالي لـEnterprise هو 10,000 طلب في يوم UTC ما لم
ينطبق استثناء فعلي.
سياسة إعادة المحاولة
Section titled “سياسة إعادة المحاولة”- لا تكرر
400أو401أو403أو404أو413أو415أو422. - عند
409 idempotency_request_in_progressانتظرRetry-Afterوأعد الطلب والقيمة المطابقين. - عند
429أو503استخدم تراجعاً أسياً محدوداً مع عشوائية واحترمRetry-After. - لا تُعد كتابة غير محسومة إلا بقيمة منع التكرار الأصلية والطلب المطابق.
- ضع حداً للمحاولات وأظهر مهمة فاشلة دائمة لمراجعة المشغّل.
طلب الدعم بأمان
Section titled “طلب الدعم بأمان”أرسل الوقت وقالب نقطة النهاية وحالة HTTP ورمز الخطأ الثابت وrequest_id. لا
ترسل بيانات Bearer أو ترويسة التفويض أو قيمة منع التكرار الخام أو جسم الطلب
الكامل أو استجابة بيانات شخصية.