التوثيقAPI v1
أقسام التوثيق

الأخطاء واستكشاف المشكلات

تعامل مع رموز الأخطاء واحتفظ بالسياق المفيد للدعم.

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

تحتوي الأخطاء على كائن error يتضمّن code وmessage وdetails وtrace. استخدم الرمز البرمجي في منطق التطبيق واحتفظ بـ trace للدعم. لا تسجّل مفتاح الوصول أو محتوى الرسائل الحسّاس.

{
  "error": {
    "code": "idempotency_key_required",
    "message": "This operation requires an Idempotency-Key.",
    "details": [],
    "trace": "<request-trace>"
  }
}

رموز الاستجابة الشائعة

الحالةما الذي تراجعه؟
400JSON غير صالح أو حقول غير مدعومة أو معرّف طلب مفقود
401مفتاح مفقود أو غير صالح
403الصلاحية أو تقييد الوكيل أو الوصول لمساحة العمل
404معرّف المورد وإمكانية ظهوره لهذا المفتاح
409هوية الطلب أو إصدار المسودّة أو تعارض الحالة
413جسم الطلب يتجاوز 256 KiB
422التحقّق من الحقول أو إعداد مرفوض
429حدّ استخدام أو معدل؛ اتبع إرشادات إعادة المحاولة
503مكوّن تنفيذ أو إمكانية غير متاحة

اجعل الخطوة التالية مفيدة

احتفظ بنقطة الوصول وحالة HTTP ورمز الخطأ وtrace. عند تعارض الحالة، اقرأ المورد الحالي قبل إرسال طلب مصحّح. شارك مثالًا منزوع البيانات الحسّاسة مع الدعم، ولا ترسل مفتاحًا حقيقيًا.