تصفح الوثائق
مرجع API
ابحث عن سبب فشل الطلب و تقرر ما إذا كانت ستصلحه أو تنتظره أو تعود
في هذه الصفحة
رموز مركز HTTP
ابدأوا HTTP الحالة، ثم قراءة رمز الخطأ ورسالة للسبب المحدد.
| الحالة | معنى | الإجراء المطلوب |
|---|---|---|
| 400 | طلب غير مستوفى | صلح المصدر، أو الحقول المطلوبة، أو أنواع البارامترات، أو رؤساء الاستجابة قبل إعادة التجريب. |
| 401 | فشل التوثيق | تحقق X-API-Key. يستعاض عن مفتاح منتهية أو ملغى؛ ولن يساعد تغيير المفتاح نفسه. |
| 402 | عدم كفاية الائتمانات | تحقق من رصيد الحساب يضاف الائتمانات أو يسمح لمالك الحساب بأن يحل الدخول قبل أن يقدم مرة أخرى. |
| 403 | Access denied | تحقق من تصريحات المصدر و حالة الحساب أو الاشتراك |
| 404 | لم يعثر عليه | تحقق من URLعمل ID وحساب الوظائف خارج حسابك المسموح به أو مصادرك يمكن أيضا إعادة 404. |
| 406 | نوع الاستجابة غير مقبول | استخدم Accept: application/json أو text/plain. اختر Markdown عبر X-Respond-With: markdown. |
| 409 | النتيجة غير جاهزة/الصراع | وبناء على ذلك، يُستعاض عن الوظيفة القائمة حتى تكتمل. ولغيرها من النقاط النهائية، حل النزاع الوارد وصفه في الجسم. |
| 410 | انتهت صلاحية النتائج | استخدم نسخة محفوظة. إعادة محاولة رابط النتيجة لا تستعيد نتيجة انتهت صلاحيتها. |
| 422 | عدم كفاية المدخلات/الوظيفة الفاشلة | أصلح الحقول المبلغ عنها وبناء على ذلك، راجعت شركة job.error: فالوظيفة الفاشلة ليس لها أي نتيجة ناجحة للقبض. |
| 429 | Limit reached | انتظر Retry-After أو retry_after. خفض معدل الطلب؛ وللاطلاع على استفسار كامل، انتظاراً للوظائف القائمة إلى finish. |
| 500 / 502 / 503 / 504 | الخدمة أو الفشل في المراحل الأولى | التراجع يقرأ بالتراجع المقيد. وللاطلاع على رقم POST أو على موعد تقديم الطلبات، انظر ما إذا كان قد تم قبول العمل قبل إرساله مرة أخرى. |
إقرأْ ردّاً خاطئاً
API استخدام الأخطاء JSONبما في ذلك عندما تطلبين نصاً سهلاً وتختلف الهيئة حسب نقطة النهاية. الفرع المعني بمركز ورمز HTTP عند وجوده؛ استخدام الرسالة أو التفاصيل لشرح المشكلة.
وتشمل الأخطاء في الأسعار عادة الخطأ والرسالة؛ والمدونة اختيارية. وقد تستخدم أخطاء التوثيق (success: false) بدلاً من error: true.
{
"error": true,
"code": "unsupported_representation",
"message": "X-Respond-With supports markdown. Omit the header for the original result fields."
}V2 problem responses use application/problem+json. استمر requestId للدعم. ويمكن أن تشمل أخطاء التقييم أيضاً fieldErrors في الميدان والرمز والرسالة.
{
"type": "https://api.flashdata.dev/problems/invalid_api_key",
"title": "Invalid API Key",
"status": 401,
"code": "invalid_api_key",
"requestId": "example-request-id",
"detail": "The API Key is invalid or unavailable."
}حالة التفتيش والرؤس والجسد
الاستخدام curl --include لرؤية الثلاثة. هذا المثال يفحص مفتاحك بحساب مجاني، ولا يقدم استفساراً. المجموعة FLASHDATA_API_KEY في بيئتك أولاً
curl --include --silent --show-error --max-time 20 \
'https://api.flashdata.dev/v2/api-access/identity' \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
--header 'Accept: application/json'متى يُعيدُ النظر
متكرر POST يمكن أن يخلق استفساراً آخر قابلاً للتعديل. ولا يثبت انقطاع الشبكة أن الطلب الأول قد رُفض. انقذوا العمل ID بمجرد أن تستلمه
| الحالة | الإجراء التالي: |
|---|---|
| المدخلات غير الصحيحة أو المفاتيح أو الأذن أو التوازن | توقف اصلح الطلب أو الحساب قبل إعادة التجريب؛ ولا تُحدِث هذه الأخطاء. |
| 429 with a wait hint | أو قيمة Retry-After (ثانية أو تاريخ HTTP)، أو قيمة JSON retry_after في ثوان. وإذا كان كلاهما حاضرين، استخدموا التأخير الأطول. |
| طلب القراء: 429/ temporary 5x/ network error | أعيدي نفس الشيء GET. بدون تلميحاً للانتظار، استخدام التأخيرات المتزايدة مع جليس، ومحاولة قصوى للإحصاء والحد الزمني. |
| POST timeout or ambiguous 5x | الحفاظ على الوظيفة الحالية ID وتحقق من حالتها إذا لم يكن ID ووردت، وفتشت تاريخ العمل قبل أن تقرر تقديمه مرة أخرى. |
تحقق من وظيفة خلفية
يعني HTTP 200 من نقطة الحالة أن القراءة نجحت. افحص job.status لمعرفة ما إذا كانت المهمة نجحت. اضبط JOB_ID على مهمتك الموجودة؛ فهذا الأمر لا يرسل بديلًا.
| job.status | الإجراء المطلوب |
|---|---|
| pending / processing | مهلاً، إذاً إستطلاع نفس الوظيفة ونتيجة لذلك، يُستعاض عن عبارة " 409 " بعبارة " . |
| completed | استرجع النتيجة واحفظها. تعيد نتائج JSON الأصلية توجيه 302 إلى التخزين؛ أما النتائج المنسّقة فتعيد الجسم مباشرة. |
| failed | وقف الاقتراع والتفتيش job.error. The result endpoint returns 422 with code result_not_ready for a failed job. |
curl --fail-with-body --silent --show-error --max-time 30 \
"https://api.flashdata.dev/v2/jobs/${JOB_ID:?Set JOB_ID}" \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
--header 'Accept: application/json'الأخطاء الشكلية للرد
| الحالة/الرمز | Fix |
|---|---|
| 400 · unsupported_representation | المجموعة X-Respond-With لإيقاف أو إزالة الرأس. |
| 406 · not_acceptable | Set Accept to application/json or text/plain; use UTF-8 if specifying a charset. |
الحصول على مساعدة مع طلب
أرسل نقطة النهاية والتوقيت بصيغة UTC وحالة HTTP ورمز الخطأ ومعرّف الطلب أو المهمة. أزل مفاتيح API والرموز وروابط URL الموقّعة من التقرير.