فيديوهاتيالتوثيق

الأخطاء

مغلِّف الخطأ، وخريطة رموز الحالة، ورموز الأخطاء المشتركة.

تستخدم كل استجابة خطأ مغلِّفًا واحدًا:

{
  "error": {
    "code": "<machine_code>",
    "message": "<human text>"
  }
}
  • code سلسلة snake_case يقرأها الحاسوب. تفرّع بناءً عليها، لا على رمز الحالة وحده.
  • message سلسلة إنجليزية يقرأها الإنسان للسجلّات وعرضها للمطوّر.

تذكر صفحة كل عملية رموز code الدقيقة التي تصدرها تلك العملية.

رموز الحالة

الرمزالمعنى
400فشل التحقّق من جسم الطلب أو الاستعلام.
401لم تُقدَّم بيانات اعتماد صالحة.
403بيانات الاعتماد صالحة لكنها لا تسمح بهذا الإجراء.
404المورد غير موجود أو غير مرئي للمستدعي.
409يتعارض الطلب مع الحالة الراهنة للمورد.
429تجاوز حدّ المعدّل.
500فشل الخادم في إكمال الطلب.

الرموز المشتركة

تظهر هذه عبر عمليات كثيرة:

الرمزالحالةالمعنى
invalid_body400فشل التحقّق من جسم الطلب.
invalid_input400فشل التحقّق من حقل.
unauthorized401المصادقة مطلوبة.
insufficient_scope403يفتقر مفتاح الواجهة البرمجية إلى الصلاحية اللازمة.
not_found404المورد غير موجود أو غير مرئي.
already_revoked409المورد المستهدف ملغًى مسبقًا.
rate_limit_exceeded429طلبات أكثر من اللازم؛ راجع Retry-After.
internal_error500خطأ خادم غير متوقّع.

تحديد المعدّل

يحمل الرمز 429 ثلاث ترويسات:

  • X-RateLimit-Limit — السقف للنافذة.
  • X-RateLimit-Remaining — الطلبات المتبقّية في النافذة.
  • Retry-After — عدد الثواني قبل إعادة المحاولة.

تراجع حتى تنقضي مدّة Retry-After، ثم أعد الطلب نفسه.