Ekstern Overvågnings-API

Mål

For integratorer, der har brug for realtidsindsigt, medfører polling af vores Telemetry API forsinkelser og skaber overhead både for integratoren og for Sofar. For at løse dette kan controlleren konfigureres til at sende telemetri til et udpeget endpoint, som leveres af integratoren. Denne 'webhook-mekanisme' muliggør live datastreams med næsten nul latens og omgår begrænsningerne ved traditionel API-polling.

Første konfiguration (startpunkt for nye brugere)

1. Tjek dit netværk

Sørg for, at din Sofar EMS har en aktiv netværksforbindelse.

2. Tilføj dine enheder

Log ind på commissioning interfacet og sørg for, at enhederne er tilføjet til Sofar EMS.

3. Konfigurer webhook via 'eksterne datakilder'

4. Indtast parametrene

1. URL og endpoint for API'et

2. Bearer-autorisering token, der anvendes til API-anmodningen. For at forhindre, at en kompromitteret controller bliver brugt til at forfalske data fra andre enheder, anbefaler vi stærkt at bruge unikke tokens pr. controller og binde hver token til en specifik lokalitet i din implementering.

3. Frekvensen for push af data (i sekunder, standard er 60s)

4. Vælg, hvilke data der skal pushes:

   • Enhedsniveau-data indeholder alle de nedenfor angivne datafelter for hver individuel node tilsluttet Sofar EMS.
   • Enhedstype-niveau indeholder aggregerede data på enhedstypeniveau (f.eks. sol, lager, fast)

Vælg derefter at inkludere alle enheder.

Endpoint-data

Endpointet skal acceptere en HTTP POST-anmodning med følgende data:

Hvis enhedstype-niveauet er valgt:

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

Hvis enhedsniveauet er valgt:

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

Mere information om de individuelle felter kan findes her: Feedback Payload Structure.