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

الهدف

بالنسبة إلى القائمين على التكامل الذين يحتاجون إلى رؤية آنية، فإن الاستعلام المتكرر عن واجهة برمجة تطبيقات بيانات القياس عن بُعد لدينا يؤدي إلى حدوث تأخيرات ويضيف عبئًا إضافيًا من جانب القائم على التكامل ومن جانب SmartgridOne. ولحل هذه المشكلة، يمكن تهيئة وحدة التحكم لإرسال بيانات القياس عن بُعد إلى نقطة نهاية محددة يوفرها القائم على التكامل. تتيح هذه «آلية webhook» تدفقات بيانات مباشرة بزمن استجابة شبه معدوم، متجاوزةً قيود الاستعلام المتكرر التقليدي لواجهة برمجة التطبيقات.

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

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

تأكد من أن SmartgridOne Controller لديه اتصال نشط بالشبكة.

2. أضف أجهزتك

سجّل الدخول إلى واجهة التشغيل وتأكد من إضافة الأجهزة إلى SmartgridOne Controller.

3. تكوين webhook عبر «مصادر البيانات الخارجية»

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

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

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

3. التكرار الذي تُرسل فيه البيانات (بالثواني، والقيمة الافتراضية هي 60 ثانية)

4. حدد البيانات التي ينبغي إرسالها:

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

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

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

يجب أن تقبل نقطة النهاية طلب 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>",
    ...
}

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