• تتوفر واجهة برمجة تطبيقات REST API أسفل عنوان URL الأساسي:

/public/external/api

• يجب إرسال جميع الطلبات عبر POST.
• تدعم واجهة برمجة تطبيقات REST API الطلبات عبر HTTPS فقط.
• يجب أن تحتوي الطلبات على العناوين التالية:

• يجب أن يكون نص الطلب كائن مشفر json يجب أن يحتوي على القيم التالية:

• عند النجاح، تقوم واجهة برمجة التطبيقات بإرجاع البيانات المطلوبة (انظر الاستعلامات أدناه) ورمز حالة HTTP 200.
• في حالة حدوث خطأ، سيتراوح رمز حالة HTTP بين 4xx و5xx اعتمادًا على الخطأ وسيحتوي كائن الاستجابة على مصفوفة بمفتاح “أخطاء”، والذي يحتوي على قائمة برسائل الخطأ التي يمكن قراءتها من قبل البشر.
• إذا لم تكن هناك بيانات مطابقة لجهاز ما سيتم إرجاع مصفوفة فارغة.
• إذا كان معرّف الجهاز غير موجود، فستكون بيانات الإرجاع لاغية.