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

الأخطاء والحدودغلاف الأخطاءكل خطأ يصدر عن الـ API له الشكل نفسه:

json

{
  "data": null,
  "success": false,
  "errorMessage": "Lens not found",
  "errorCode": 404
}

قيمة success هي false، وقيمة data هي null.

errorCode هو رمز حالة HTTP، على هيئة رقم.

errorMessage جملة إنجليزية قصيرة موجّهة إلى المطوّرين. اعرض لمستخدميك رسائلك الخاصة، وحدّد ما تفعله بناءً على رمز الحالة لا على نص الرسالة.

الإجابة الناجحة تكون { "data": { … }, "success": true }.ترتيب الفحوصاتتفحص واجهة التسليم (delivery API) الطلب بهذا الترتيب، وتجيب بأول مشكلة تجدها:

مفتاح API — 401؛

ما إذا كان المنتج مفعّلًا لمساحة عملك — 403؛

صيغة العنوان — 400؛

العنصر وإصداره — 404.

حالات التسليم

الحالة

متى

ما الذي تفعله

200

عُثر على الإصدار.

نزّل الحزمة وتحقّق منها. راجع التنزيل الآمن.

400

المعرّف ليس UUID، أو الإصدار ليس عددًا صحيحًا من 1 إلى 2147483647.

صحّح الطلب. انسخ المعرّفات من صفحة Developers (المطوّرون).

401

الرسالة "Missing or invalid API key": لا توجد ترويسة X-Api-Key، أو المفتاح غير معروف أو ملغى.

تحقّق من الترويسة ومن المفتاح. إذا كان المفتاح قد أُلغي، فأصدر مفتاحًا جديدًا. راجع مفاتيح API.

403

الرسالة "Face lenses are not enabled for this tenant" أو "Screen effects are not enabled for this tenant".

هذا المنتج غير مفعّل لمساحة عملك. تعرض صفحة Developers المنتجات المفعّلة. تواصل مع دعم IngevoraMirage لتفعيل أحدها.

404

الرسالة "Lens not found" أو "Screen effect not found": معرّف غير معروف، أو عنصر يخص مساحة عمل أخرى، أو عنصر لم يُنشر قط، أو إصدار مثبّت غير موجود. والمسار المكتوب خطأً يُرجع 404 أيضًا.

تحقّق من المعرّف، وتأكّد من أن العنصر منشور. واصل تقديم ما لديك في التخزين المؤقت.

429

الرسالة "Monthly delivery limit reached". راجع ما يلي.

واصل تقديم إصداراتك المخزّنة مؤقتًا. تعود الطلبات إلى تلقّي إجابات بدءًا من الشهر التالي، أو بعد تغيير الخطة.

500 وغيره من 5xx

حدث خلل من جهة IngevoraMirage. تقول الحالة 500 دائمًا "Internal server error".

أعد المحاولة لاحقًا مع إطالة الانتظار بين المحاولات، وواصل تقديم إصداراتك المخزّنة مؤقتًا.

لا يوجد حد للمعدّل في الدقيقة على طلبات التسليم. والحالة 429 من مسار تسليم تعني دائمًا الحد الشهري.حافظ على عمل تطبيقكخطّط للأخطاء منذ البداية:

خزّن مؤقتًا كل حزمة تحقّقت منها، حسب المعرّف والإصدار. عندها لن يترك أي خطأ مستخدميك بلا عدسة.

تعامل مع الطلب الفاشل على أنه "لا جديد"، واحتفظ بالإصدار الذي لديك.

لا تستعلم عند كل تشغيل أو كل شاشة. استعلم من خادمك، وفق جدول تختاره، ودع تطبيقاتك تسأل خادمك.

الحد الشهري لطلبات التسليمإذا كانت خطة مساحة عملك تضع حدًا شهريًا لطلبات التسليم، فهكذا يعمل:

يُحتسب كل طلب تسليم يتم بأحد مفاتيح مساحة عملك. تُعدّ الطلبات لكل مفتاح ولكل يوم بتوقيت UTC، ويُطبَّق الحد على مجموع مساحة العمل خلال الشهر بتوقيت UTC.

عندما يبلغ المجموع 80 % من الحد، ثم مرة أخرى عند 100 %، يتلقّى مالكو مساحة العمل (Owners) بريدًا إلكترونيًا.

تظل الطلبات تُخدم حتى 120 % من الحد، لذا فإن بلوغ 100 % لا يوقف شيئًا.

بعد تجاوز 120 %، يُجاب كل طلب تسليم بالحالة 429 "Monthly delivery limit reached"، حتى يبدأ الشهر التالي بتوقيت UTC أو تغيّر مساحة العمل خطتها.

تنزيل ملفات البيان والصور لا يُحتسب أبدًا. وتستمر العدسات والتأثيرات الموجودة على هواتف مستخدميك في العمل.

كلما قلّ عدد مرات استعلام خادمك، امتدّ حدّك أكثر. ملفات الإصدار المثبّت لا تتغيّر أبدًا، لذا بعد أن يتحقّق خادمك منها، لا يحتاج إلى السؤال عن ذلك الإصدار مجددًا.حدود الحزمتُفحص حدود الطبقات والصور وحجم الحزمة في المحرّر عند التحقّق والنشر، لا في واجهة التسليم. راجع القواعد والمناطق المحظورة.صفحات ذات صلة

واجهة التسليم — المسارات وإجاباتها.

مفاتيح API — إصدار المفاتيح وإلغاؤها.