تستخدم واجهة برمجة التطبيقات API الخاصة بـ Benzinga رموز استجابة HTTP التقليدية للدلالة على نجاح أو فشل طلب الـ API. بشكل عام:
- 2xx: نجاح.
- 4xx: خطأ من جهة العميل (مثلًا، معلمة مفقودة، مفتاح غير صالح).
- 5xx: خطأ من جهة الخادم (حدث خلل ما من جانب Benzinga).
تحقَّق دائمًا أولًا من رمز حالة HTTP لتحديد ما إذا كان الطلب ناجحًا. لا تعتمد فقط على جسم الاستجابة، إذ يمكن أن يختلف التنسيق بين نقاط نهاية واجهة برمجة التطبيقات API المختلفة.
| Code | Status | Description |
|---|
| 200 | OK | تم تنفيذ الطلب بنجاح. |
| 400 | Bad Request | الطلب غير مقبول، غالبًا بسبب معلمة مفقودة أو غير صالحة. |
| 401 | Unauthorized | لم يتم توفير مفتاح واجهة برمجة التطبيقات API صالح. تحقّق من ترويسة Authorization أو معامل token. |
| 402 | Request Failed | كانت المعلمات صالحة لكن الطلب فشل لأسباب تتعلق بمنطق الأعمال. |
| 403 | Forbidden | مفتاح واجهة برمجة التطبيقات API صالح، لكن لا تملك صلاحية الوصول إلى هذا المورد. |
| 404 | Not Found | المورد المطلوب (مثلًا: ID أو endpoint) غير موجود. |
| 429 | Too Many Requests | تجاوزت حد معدل الطلبات المسموح به. |
| 500 | Internal Server Error | حدث خطأ ما في خوادم Benzinga. هذه الحالات نادرة. |
| 503 | Service Unavailable | الخدمة غير متاحة مؤقتًا (مثلًا بسبب الصيانة). |
string أو كائن JSON مسطّحًا يحتوي على رسالة.
"Invalid or Missing Query Parameters"
{
"message": "Invalid page size"
}
{
"data": null,
"errors": [
{
"code": "database_query_error",
"id": "ERR_12345",
"value": "Unable to fetch data for symbol: INVALID"
}
],
"ok": false
}
- تحقق من رمز حالة HTTP. إذا كان
>= 400، فاعتبره خطأً.
- سجّل جسم الاستجابة. اكتب الجسم بالكامل في سجلاتك لأغراض تصحيح الأخطاء.
- اعرض رسالة عامة. ما لم تكن متكاملاً مع نقطة نهاية محددة وتعرف صيغة الخطأ الخاصة بها بدقة، اعرض رسالة عامة مثل “حدث خطأ ما” للمستخدمين النهائيين إلى جانب رمز الحالة.
