واجهة برمجة تطبيقات المراقبة الخارجية

الهدف

بالنسبة للمندمجين الذين يحتاجون إلى رؤية في الوقت الحقيقي، فإن الاستطلاع عبر واجهة برمجة تطبيقات القياس عن بُعد (Telemetry API) يسبب تأخيرات ويضيف عبئًا على الطرفين؛ من جهة المندمج ومن جهة Sofar. لحل هذه المشكلة، يمكن تكوين وحدة التحكم لإرسال بيانات القياس إلى نقطة نهاية معينة يتم توفيرها بواسطة المندمج. هذه الآلية المعروفة بـ 'Webhook' تمكّن من تدفق البيانات الحي تقريبًا بدون تأخير، متجاوزةً القيود التي تفرضها الطرق التقليدية للاستطلاع عبر واجهة البرمجة.

الإعداد لأول مرة (نقطة البداية للمستخدمين الجدد)

1. تحقق من شبكتك

تأكد من أن Sofar EMS الخاص بك متصل بشبكة نشطة.

2. أضف أجهزتك

قم بتسجيل الدخول إلى واجهة التكليف وتأكد من إضافة الأجهزة إلى Sofar EMS.

3. قم بتكوين Webhook عبر 'مصادر البيانات الخارجية'

4. أدخل المعلمات

1. عنوان الـ URL ونقطة النهاية لواجهة البرمجة

2. رمز التفويض (Bearer Token) المستخدم في طلب واجهة البرمجة. لمنع استخدام وحدة تحكم مخترقة في تزوير بيانات من أجهزة أخرى، نوصي بشدة باستخدام رموز فريدة لكل وحدة تحكم وربط كل رمز بموقع محدد في تطبيقك.

3. تردد دفع البيانات (بالثواني، الافتراضي هو 60 ثانية)

4. اختر البيانات التي يجب دفعها:

   • بيانات على مستوى الجهاز تحتوي على كل حقول البيانات المحددة أدناه، لكل عقدة متصلة بالـ Sofar EMS بشكل منفرد.
   • بيانات على مستوى نوع الجهاز تحتوي على بيانات مجمعة على مستوى نوع الجهاز (مثل الطاقة الشمسية، التخزين، الثابتة)

بعد ذلك، اختر تضمين كل الأجهزة.

بيانات نقطة النهاية

يجب أن تقبل نقطة النهاية طلب HTTP POST بالبيانات التالية:

إذا تم اختيار مستوى نوع الجهاز:

{
    "time": "<Unix Timestamp>",
    "siteNodeId": "<Site NodeID>",
    "grid": "<Grid Fields>",
    "solar": "<Solar Fields>",
    "storage": "<Storage Fields>",
    "heat_pump": "<Heat Pump Fields>",
    "switched_load": "<Switched Load Fields>",
    "variable_power_load": "<Variable Power Load Fields>",
}

إذا تم اختيار مستوى الجهاز:

{
    "time": "<Unix Timestamp>",
    "siteNodeId": "<Site NodeID>",
    "nodeId1": "<Node Fields>",
    "nodeId2": "<Node Fields>",
    ...
}

يمكن العثور على مزيد من المعلومات حول الحقول الفردية هنا: هيكل حمولة ردود الفعل.