Ideal House
تخطّي إلى المحتوى

مرجع رموز خطأ API#

URL الأساسي: https://api.ideal.house
الإصدار: v1
آخر تحديث: 2026-03-06


📖 نظرة عامة#

جميع استجابات API تتبع بنية JSON موحدة. عند حدوث خطأ، سيحتوي الحقل code على رمز خطأ غير صفري، وسيوفر الحقل message وصفًا مقروءًا للبشر للخطأ.

تنسيق الاستجابة الموحد

json
{
  "code": 1001,
  "message": "Request failed",
  "data": null
}
الحقلالنوعالوصف
codeinteger0 = نجاح؛ أي قيمة أخرى تشير إلى خطأ
messagestringوصف الخطأ المقروء للبشر
dataanyحمولة الاستجابة; null عند الخطأ

✅ رمز النجاح#

الرمزالاسمالوصف
0SUCCESSنجح الطلب

مثال

json
{
  "code": 0,
  "message": "success",
  "data": { }
}

❌ رموز الخطأ#

🔧 أخطاء عامة#

الرمزالاسمالوصفالإجراء المقترح
1001FAILEDفشل الطلب (خطأ عام)تحقق من حقل message للحصول على تفاصيل محددة
1003INTERNAL_ERRORخطأ في الخادم الداخليأعد محاولة الطلب بعد فترة وجيزة؛ اتصل بالدعم إذا استمر
1011PARAM_ERRORخطأ معامل الطلبتحقق من توفير جميع المعاملات المطلوبة وتنسيقها بشكل صحيح

🔐 أخطاء المصادقة#

الرمزالاسمالوصفالإجراء المقترح
5002API_KEY_INVALIDمفتاح API غير صالح أو مفقودتأكد من تضمين رأس APIKEY وأن القيمة صحيحة

🛡️ أخطاء الرقابة على المحتوى#

الرمزالاسمالوصفالإجراء المقترح
9010SCAN_TEXT_ERRORلم يجتز التوجيه النصي مراجعة المحتوى — يحتوي على محتوى محظورعدّل المطالبة لإزالة أي محتوى حساس أو غير قانوني
9038PROHIBITED_CONTENTتحتوي صورة الإخراج المُولَّدة على محتوى محظورعدّل التوجيه النصي/النمط/الإدخالات وأعد المحاولة

💰 أخطاء الرصيد#

الرمزالاسمالوصفالإجراء المقترح
9051COINS_NOT_ENOUGHرصيد غير كافٍ / اعتماداتقم بتعبئة رصيد حسابك وحاول مرة أخرى

📋 ملخص رموز الخطأ الكامل#

الرمزالاسمالوصف
0SUCCESSنجح الطلب
1001FAILEDفشل الطلب (عام)
1003INTERNAL_ERRORخطأ داخلي في الخادم
1011PARAM_ERRORخطأ في معلمة الطلب
5002API_KEY_INVALIDمفتاح API غير صالح
9010SCAN_TEXT_ERRORتحتوي مطالبة النص على محتوى محظور
9038PROHIBITED_CONTENTتحتوي صورة الإخراج المُولّدة على محتوى محظور
9051COINS_NOT_ENOUGHرصيد / عملات غير كافية

📦 أمثلة على استجابات الخطأ#

1001 — فشل الطلب#

json
{
  "code": 1001,
  "message": "Request failed",
  "data": null
}

1003 — خطأ في الخادم الداخلي#

json
{
  "code": 1003,
  "message": "Internal server error",
  "data": null
}

1011 — خطأ في المعلمة#

json
{
  "code": 1011,
  "message": "Request parameter error: imageUrl is required",
  "data": null
}

5002 — مفتاح API غير صالح#

json
{
  "code": 5002,
  "message": "Invalid API Key",
  "data": null
}

9010 — فشل رقابة محتوى النص#

json
{
  "code": 9010,
  "message": "Text prompt failed content review, contains prohibited content",
  "data": null
}

9038 — محتوى محظور في الإخراج#

json
{
  "code": 9038,
  "message": "Prohibited content",
  "data": null
}

9051 — رصيد غير كافٍ#

json
{
  "code": 9051,
  "message": "Insufficient coins",
  "data": null
}

💡 أفضل ممارسات التعامل مع الأخطاء#

  1. تحقق دائمًا من code — لا تعتمد فقط على رموز حالة HTTP; افحص دائمًا حقل code في جسم الاستجابة.
  2. عالج 1001 بشكل ديناميكي — هذا رمز خطأ عام؛ سيحتوي حقل message على السبب المحدد.
  3. أعد المحاولة عند 1003 — أخطاء جانب الخادم عادة ما تكون عابرة؛ نفذ منطق إعادة المحاولة مع زيادة فترات الانتظار أُسّيًا.
  4. تحقق من المدخلات قبل الإرسال — تجنّب أخطاء 1011 بالتحقق من الحقول المطلوبة على جانب العميل قبل إجراء استدعاء API.
  5. الرقابة على المحتوى — إذا تلقيت 9010 أو 9038، راجع محتواك مقابل سياسة المحتوى على المنصة قبل إعادة الإرسال.

© Ideal House ذكاء اصطناعي — جميع الحقوق محفوظة.