الأخطاء والحدود

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

شكل الخطأ

كل خطأ بصيغة JSON وفيه message مقروءة:

{
  "message": "Invalid API key."
}

وأخطاء التحقق تضيف كائن errors، كل مفتاح فيه اسم حقل، وكل قيمة قائمة رسائل:

{
  "message": "The Name field is required.",
  "errors": {
    "name": ["The Name field is required."]
  }
}

الرسائل بالإنجليزية وقد تتغير صياغتها. قرر ما تفعله من رمز الحالة ومفاتيح errors، لا من نص الرسالة.

ترتيب الفحوص

يُفحص كل طلب بهذا الترتيب، وأول فشل هو الذي يجيب:

1. حد العنوان المُرسِل، 600 طلب في الدقيقة للمسار. وما زاد يتلقى 429 Too Many Attempts.
2. HTTPS. الطلب عبر HTTP العادي يتلقى 403 HTTPS is required.
3. المفتاح. المفتاح المفقود أو الخاطئ أو الملغى، أو الذي لم يعد منشئه أو شركته نشطًا، يتلقى 401 Invalid API key.
4. الباقة والدور المخصص للمنشئ. ومن دون واجهة API يكون الرد 403 API access is not in this plan.
5. في POST وDELETE: المفتاح بصلاحية قراءة فقط يتلقى 403 This key is read only.
6. في POST وDELETE: الجسم غير المعلن أنه JSON يتلقى 415 Send JSON.
7. حد المفتاح، 120 طلبًا في الدقيقة. وما زاد يتلقى 429 Too many requests.
8. المسار نفسه: الدور والتحقق والسجلات.

رموز الحالة

إعادة المحاولة بأمان

أعد محاولة 429 و500 فقط، والطلبات التي لم يصل لها رد. انتظر قبل كل محاولة وأطل الانتظار في كل مرة. وتذكر أن إنشاء فرصة أو إضافة ملاحظة مرتين ينشئ سجلين، فتحقق قبل إعادتهما. راجع تكرار الطلب.

الحدود

وقد تحدد باقتك أيضًا عدد جهات الاتصال في الشركة. فإن بلغته فإنشاء جهة يرد 422 والخطأ تحت limit.

حل المشكلات