كيف تعمل الواجهة البرمجية لـDarbase

المصادقة

رمز JWT من نوع Bearer، يُصدر لكل مستأجر. تحمل الرموز جمهورًا محدّدًا، وجماهير المكتب ومدير المنصة وبوابة الوكالات منفصلة — والرمز الصادر لأحدها يُرفض لدى الآخر بدل أن يُقبل جزئيًا.

صيغة الاستجابة

كل استجابة ناجحة هي { success: true, data: T }. أما الأخطاء فرموز HTTP قياسية مع رسالة، ولا تُرسل أبدًا كاستجابة 200 تحمل كائن خطأ. إن كنت تكتب عميلًا، تفرّع على الحالة ثم اقرأ data.

التقسيم

مسارات القوائم تقبل take وskip، وتحدّ take عند 100. ولا يوجد مسار قائمة بلا حدّ في الواجهة كلّها، وهذا مقصود — المستأجر الذي لديه أربعون ألف جهة اتصال لا ينبغي أن يستطيع طلبها كلّها في طلب واحد.

الأخطاء

400 لطلب مشوّه، و401 لرمز مفقود أو منتهٍ، و403 حين يكون الرمز صالحًا لكن الجمهور أو الدور خاطئ، و404 حين يكون المورد موجودًا لدى مستأجر آخر كما حين لا يكون موجودًا أصلًا. والأخيرة مقصودة: 404 بدل 403 تتجنّب تأكيد وجود سجلّ لدى مستأجر آخر.

خطافات الويب

لا يرسل Darbase أي خطافات ويب صادرة بعد، فلا شيء للاشتراك فيه.

حدود المعدّل

تُطبَّق الحدود لكل عنوان IP: ‏100 طلب في 60 ثانية. وتسمح مسارات المصادقة بـ10 طلبات في 60 ثانية، ويُقفل الحساب بعد 5 محاولات دخول فاشلة. وتحمل الاستجابة 429 ترويسة Retry-After، فانتظر تلك المدة قبل أن ترسل الطلب مرة أخرى.

تبيع وحدات على الخارطة؟ اطّلع على صفحات مبيعات المطوّرين