الانتقال إلى المحتوى الرئيسي
تقوم واجهات برمجة التطبيقات Plato بإرجاع رسائل الخطأ JSON حيثما أمكن ذلك.

شكل الخطأ

عادةً ما تُرجع نقاط نهاية REST أحد هذه الأشكال:
{
  "message": "No apiKey provided."
}
``````json
{
  "error": "Unauthorized API key."
}
تؤدي مكالمات SDK إلى ظهور أخطاء tRPC المكتوبة. قم بإلقاء القبض عليهم في التكامل الخاص بك وقم بتسجيل الرسالة والحالة واسم الإجراء.

رموز الحالة المشتركة

حالةمعنى
400الطلب غير صالح، أو يفتقد الحقول المطلوبة، أو فشل التحقق من الصحة.
401مفتاح API مفقود أو منتهي الصلاحية أو غير صالح أو غير مسموح به للعملية.
403مفتاح API صالح ولكن دوره لا يتمتع بالإذن المطلوب.
404السجل المطلوب غير موجود في مساحة عمل المفتاح API.
429الطريق محدود السعر. أبطئ ثم أعد المحاولة لاحقًا.
500تعذر على Plato إكمال الطلب. أعد المحاولة لاحقًا أو اتصل بالدعم إذا تكرر الأمر.

حدود الصفحات

تعرض واجهات برمجة التطبيقات المختلفة أنماطًا مختلفة لترقيم الصفحات. تستخدم نقاط نهاية قائمة CMS:
limit: 1 to 100
offset: 0 or higher
استخدام نقاط نهاية القائمة:
page: 1 or higher
limit: 1 to 100
تستخدم نقاط نهاية قائمة Connect360 SDK المؤشرات:
{
  limit: 50,
  cursor: "next_cursor"
}

حدود تغذية الطلب

تقوم خلاصة طلبات المطعم بإرجاع ما يصل إلى 50 طلبًا لكل طلب. يمكن أن تصل النطاقات الزمنية إلى 5 أيام عند توفير كل من date وendDate.

إعادة محاولة التوجيه

أعد المحاولة فقط عندما يكون الفشل مؤقتًا. إعادة المحاولة:
  • مهلات الشبكة.
  • 429 بعد الانتظار.
  • 500 أو 503 بعد مهلة قصيرة.
لا تقم بإعادة المحاولة حتى يتم إصلاحه:
  • مفتاح API غير صالح.
  • إذن مفقود.
  • حقل غير معروف.
  • الحقل المطلوب مفقود.
  • معرف العلاقة غير صالح.

العجز

تم تصميم بعض عمليات SDK لإعادة استخدام السجلات الموجودة، مثل getOrCreateConversation. يمكن لعمليات الكتابة مثل إنشاء CMS وإرسال النموذج وإرسال الرسائل إنشاء سجلات جديدة في كل مرة يتم الاتصال بها. اجعل التكامل الخاص بك غير فعال عندما تكون عمليات الإرسال المكررة ممكنة.