API de Surveillance Externe

Objectif

Pour les intégrateurs nécessitant une visibilité en temps réel, interroger notre API de Télémétrie introduit des délais et génère une charge tant du côté de l’intégrateur que du côté de Sofar. Pour y remédier, le contrôleur peut être configuré pour envoyer la télémétrie à un point de terminaison désigné fourni par l’intégrateur. Ce « mécanisme de webhook » permet des flux de données en direct avec une latence quasi nulle, contournant ainsi les limites des interrogations API traditionnelles.

Configuration initiale (point de départ pour les nouveaux utilisateurs)

1. Vérifiez votre réseau

Assurez-vous que votre Sofar EMS dispose d’une connexion réseau active.

2. Ajoutez vos appareils

Connectez-vous à l’interface de mise en service et assurez-vous que les appareils sont ajoutés au Sofar EMS.

3. Configurez le webhook via les « sources de données externes »

4. Saisissez les paramètres

1. L’URL et le point de terminaison de l’API

2. Le jeton d’autorisation bearer utilisé pour la requête API. Afin d’éviter qu’un contrôleur compromis soit utilisé pour falsifier des données provenant d’autres appareils, nous recommandons vivement d’utiliser des jetons uniques par contrôleur et d’associer chaque jeton à un emplacement spécifique dans votre implémentation.

3. La fréquence à laquelle les données sont envoyées (en secondes, la valeur par défaut est 60s)

4. Sélectionnez les données à envoyer :

   • Les données au niveau de l’appareil contiennent tous les champs de données spécifiés ci-dessous, par nœud individuel connecté au Sofar EMS.
   • Le niveau type d’appareil contient des données agrégées au niveau du type d’appareil (par exemple solaire, stockage, fixe)

Ensuite, sélectionnez d’inclure tous les appareils.

Données du point de terminaison

Le point de terminaison doit accepter une requête HTTP POST avec les données suivantes :

{
    "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>",
}

Plus d’informations sur les champs individuels sont disponibles ici : Feedback Payload Structure.