الأخطاء
الأخطاء وثائق مشكلات وفق RFC 9457(يُفتح في علامة تبويب جديدة) (Content-Type: application/problem+json):
{
"type": "about:blank",
"title": "Invalid request",
"status": 400,
"detail": "unknown country",
"code": "unknown_country",
"request_id": "01a166eb2f3a76c8b7c8a8c37d21aae3"
}codeثابت ومخصص للبرامج. اجعل منطق برنامجك يتفرع بناءً عليه، لا علىdetailالذي قد تتغير صياغته.- يُرسَل
request_idأيضًا في الترويسةX-Request-Id. اذكره عند التواصل مع الدعم. ويمكنك إرسالX-Request-Idخاص بك (من 8 إلى 64 محرفًا من الحروف والأرقام و.و_و-) لربط السجلات بعضها ببعض. - المُدخلات التي لا تطابق المخطط تُرجع
400مع الرمزinvalid_requestوقائمةerrors: مؤشر JSON إلى كل حقل، ورمز، ورسالة.
الحالات
| الحالة | المعنى | إعادة المحاولة؟ |
|---|---|---|
| 400 | الطلب غير صالح (يبيّن code السبب) | بعد إصلاحه |
| 401 | لا توجد بيانات اعتماد، أو أنها غير صالحة | بعد إصلاحها |
| 403 | بيانات اعتماد صالحة، لكن الإجراء غير مسموح (قد يبيّن code السبب، مثل no_org_read) | لا |
| 404 | غير موجود، أو ليس لك (لا تميّز الواجهة البرمجية بين الحالتين) | لا |
| 409 | يتعارض مع الحالة الراهنة (يبيّن code أيّ تعارض) | بعد قراءة الحالة مجددًا |
| 413 | جسم الطلب كبير جدًا | لا |
| 429 | حدّ المعدل أو الحصة اليومية (rate_limited، quota_exceeded) | بعد انقضاء Retry-After |
| 5xx | خطأ من جانبنا، أو من جانب شريك (503 مع code مثل escrow_unavailable) | مع تباعد متزايد بين المحاولات |
الرموز التي ستصادفها كثيرًا: invalid_request، وunauthorized، وforbidden، وnot_found، وrate_limited، وquota_exceeded، وpersonal_data (احتوى نص على رقم هاتف أو عنوان بريد إلكتروني أو رقم هوية)، وunknown_country، وwebhook_url_refused، وunknown_event_types، وtoo_many_webhooks، وrotation_pending، وwebhook_disabled. وتسرد وثيقة OpenAPI كل رمز يمكن أن تُرجعه كل عملية.