Skip to content

رموز الأخطاء

عندما يفشل طلب، تُرجع واجهة API استجابة خطأ JSON مع code قابل للقراءة آلياً وmessage قابل للقراءة بشرياً:

json
{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable description of the error"
  }
}

حقل code ثابت وآمن للمطابقة في منطق تطبيقك. حقل message قد يتغير بمرور الوقت وهو مخصص للتسجيل وتصحيح الأخطاء.

مرجع رموز الأخطاء

الرمزحالة HTTPالوصفقابل لإعادة المحاولةالحل
UNAUTHORIZED401رمز مصادقة مفقود أو غير صالح أو منتهي الصلاحيةلاتحقق من أن مفتاح API صالح وغير منتهي
KEY_EXPIRED401تجاوز مفتاح API تاريخ انتهاء صلاحيتهلاأنشئ مفتاح API جديداً في لوحة التحكم أو عبر API
FORBIDDEN403مصادق عليه لكن غير مفوض لهذا الموردلايمكنك فقط الوصول إلى مواردك الخاصة
NOT_FOUND404المورد المطلوب غير موجودلاتحقق من صحة معرّف المورد
VALIDATION_ERROR400فشل جسم الطلب في التحقق من المخططلاتحقق من الحقول المطلوبة وأنواع البيانات تطابق المخطط
INVALID_MIME_TYPE400الملف المرفوع بنوع MIME غير مدعوملااستخدم نوع ملف مدعوم (PDF أو DOCX)
FILE_TOO_LARGE400الملف المرفوع يتجاوز حد الحجم 10 ميجابايتلاقلّل حجم الملف أو قسّمه إلى مستندات أصغر
MAX_KEYS_REACHED400تم الوصول إلى الحد الأقصى وهو 10 مفاتيح API نشطةلاألغِ المفاتيح غير المستخدمة قبل إنشاء مفاتيح جديدة
USAGE_LIMIT_EXCEEDED429تم الوصول إلى حد الاستخراج الشهريلاقم بترقية خطتك أو انتظر فترة الفوترة التالية
INTERNAL_ERROR500خطأ غير متوقع في الخادمنعمأعد المحاولة مع تراجع أسي. إذا استمر، تواصل مع الدعم
NOT_CONFIGURED501خدمة مطلوبة من جانب الخادم غير مكوّنةلاتواصل مع الدعم -- هذا يشير إلى مشكلة في تكوين الخادم
EXTRACTION_FAILED502فشلت معالجة استخراج الذكاء الاصطناعينعمأعد المحاولة -- قد تكون مشكلة مؤقتة. تحقق من صحة ملف PDF وقابليته للقراءة
EXTRACTION_PARSE_ERROR502أرجع الذكاء الاصطناعي استجابة لا يمكن تحليلها كـ JSONنعمأعد المحاولة -- قد ينتج الذكاء الاصطناعي مخرجات صالحة في محاولة لاحقة

الأخطاء القابلة لإعادة المحاولة

فقط رموز الأخطاء التالية يجب إعادة محاولتها:

  • INTERNAL_ERROR -- فشل غير متوقع على جانب الخادم.
  • EXTRACTION_FAILED -- فشلت عملية استخراج الذكاء الاصطناعي، غالباً بسبب مشاكل مؤقتة.
  • EXTRACTION_PARSE_ERROR -- أرجع الذكاء الاصطناعي مخرجات مشوّهة لا يمكن تحليلها.

عند إعادة المحاولة، استخدم تراجعاً أسياً يبدأ من ثانية واحدة، بحد أقصى 3 محاولات:

المحاولةالتأخير
المحاولة الأولىثانية واحدة
المحاولة الثانيةثانيتان
المحاولة الثالثة4 ثوانٍ

إذا استمر فشل الطلب بعد 3 محاولات، سجّل الخطأ وأظهره للمستخدم أو نظام المراقبة الخاص بك.

للحصول على دليل كامل حول تنفيذ منطق إعادة المحاولة، راجع معالجة الأخطاء.

ملخص رموز حالة HTTP

الحالةالمعنى
200نجاح -- اكتمل الطلب بنجاح
400طلب سيء -- خطأ في التحقق أو نوع ملف غير صالح أو ملف كبير جداً أو تم الوصول إلى حد المفاتيح
401غير مصرح به -- فشلت المصادقة (رمز مفقود أو غير صالح أو منتهي الصلاحية)
403محظور -- مصادق عليه لكن غير مفوض للمورد المطلوب
404غير موجود -- المورد المطلوب غير موجود
429طلبات كثيرة جداً -- تم تجاوز حد استخدام الاستخراج الشهري
500خطأ داخلي في الخادم -- فشل غير متوقع على جانب الخادم
501غير مُنفّذ -- خدمة مطلوبة من جانب الخادم غير مكوّنة
502بوابة سيئة -- فشل استخراج أو تحليل الذكاء الاصطناعي

وثائق DocMap API