الانتقال إلى المحتوى الرئيسي
تستخدم الأخطاء رموز حالة HTTP القياسية وغلاف JSON متّسق:
{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_SCOPE",
    "message": "API key does not have the required scope",
    "details": { "required_scope": "tickets:write" }
  }
}
تفرّع دائماً بناءً على error.code القابل للقراءة آلياً، وليس على message البشري.

الرموز الشائعة

الحالةالرمزالمعنى
401MISSING_AUTHORIZATIONلم يتم تقديم أي بيانات اعتماد
401INVALID_API_KEYالمفتاح غير صالح أو ملغى أو منتهي الصلاحية
403INSUFFICIENT_SCOPEيفتقر المفتاح إلى النطاق الذي تتطلبه نقطة النهاية
403ENDPOINT_NOT_PUBLICنقطة النهاية غير متاحة لمفاتيح API (لوحة التحكم فقط)
403IP_NOT_ALLOWEDاستُخدم المفتاح من عنوان IP ليس في قائمة السماح
404NOT_FOUNDالمورد غير موجود في مؤسستك
422VALIDATION_ERRORفشل التحقق من جسم الطلب
429RATE_LIMIT_EXCEEDEDعدد كبير جداً من الطلبات — راجع حدود المعدّل
500INTERNAL_ERRORحدث خطأ في جانبنا