API-Schnittstelle
Mit der neuen API ist es möglich, die von energyLIVE erfassten Echtzeitdaten des Smart Meters in eigene/dritte Systeme einzubinden. Dies erlaubt eine flexible Nutzung der Daten und kann als Basis für Hausautomatisierungs- und Energiemanagementsysteme genutzt werden, beispielsweise in Kombination mit der smartENERGY Strompreis-API für den variablen Stromtarif smartCONTROL.
| Allgemeine Spezifikation: | |
| Basis-URL | https://backend.energylive.e-steiermark.com/api/v1/ |
Authentifizierung: Es muss stets der HTTPS-Header „X-API-KEY“ mit einem gültigen Schlüssel aus dem Kundenportal bei der Anfrage vorhanden sein (e.g. „X-API-KEY: apiSchluesselLautKundenportal".
Aktuelle Daten eines Interfaces abfragen:
Beschreibung: Liefert die zuletzt von energyLIVE erfassten Vebrauchswerte des Smart Meters. Daneben werden auch Informationen zum Systemstatus geliefert.
Endpunkt: devices/I-XXXXXXXX-XXXXXXXX/measurements/latest
Die UID des Interfaces (hier in violett markiert) muss dem Kundenportal entnommen werden („energyLIVE verwalten“).
Methode: GET
Format:
JSON, Array< {
measurement: string,
timestamp: number (Unix-Timestamp mit ms),
value: number} >
| Spezifikation: | |
| measurement | Gibt an welchen Wert es sich handelt. Bei elektrischen Größen wir hier der OBIS-Code angegeben |
| timestamp | Der Zeitpunkt, wann die Messung in der energyLIVE-Datenbank erfasst wurde. Als 13-Stellen UNIX-Timestamp (mit ms) ausgeführt. |
| value | Der zurückgelieferte Wert. Die Einheiten lauten bei elektrischen Größen wie folgt: Zählerstand -> Wh und Momentanleistung -> W |
Beispielanfrage (curl):
curl -X GET -H "X-API-KEY: VsMgAMu7D6SD7jXEzbDlw_16KUn5I4XziIxki8kGPQk"
https://backend.energylive.e-steiermark.com/api/v1/devices/I-10082023-01658401/measurements/latest
Ausgabe:
[
{
"measurement": "0100010700",
"timestamp": 1726559995000,
"value": 138.0,
},
{
"measurement": "0100010800",
"timestamp": 1726559995000,
"value": 9577201.0,
},
{
"measurement": "0100020700",
"timestamp": 1726559975000,
"value": 0.0,
},
{
"measurement": "0100020800",
"timestamp": 1726559995000,
"value": 0.0,
},
{
"measurement": "batteryVoltage",
...
]