Die Remote-API gibt Ihrer Plattform direkten Lesezugriff auf die Monitoring-Daten der Photovoltaik- und Speicheranlagen, die mit Ihrer Organisation verknüpft sind. Sie richtet sich an alle, die diese Daten in ihre eigenen Systeme übernehmen möchten.
Was sie bietet
- Anlagenstammdaten: Name, Land, Zeitzone, Adresse
- Konnektivität: Anlage und Gateways online oder offline
- Momentanleistung und Leistungsreihen: PV, Verbrauch, Netz, Batterie und Ladezustand
- Energiesummen und -reihen: erzeugt, verbraucht, bezogen, eingespeist, geladen und entladen
- aktive und historische Alarme
Es handelt sich um eine REST API über HTTPS: Requests und Responses sind JSON, der Zugriff erfolgt Machine-to-Machine mit OAuth 2.0 Client Credentials. Daten werden per Polling abgerufen: Die API sendet keine Daten von sich aus.
| Adresse | |
|---|---|
| Basis-URL der API | https://api.cloud.energyincloud.com |
| Token-Endpoint | https://k8s.prod.cloud.energyincloud.com/webapp/oauth/token |
Alle Daten-Endpoints liegen unter /v1.
Was sie nicht tut
- Sie ändert keine Anlagen. Diese Version ist schreibgeschützt. Steuerfunktionen (Sollwerte, Betriebsmodus) sind nicht aktiv: Sie werden im Rahmen einer gesonderten Vereinbarung freigeschaltet.
- Sie sieht keine Anlagen anderer Organisationen. Eine Anlage, die nicht mit Ihrer Organisation verknüpft ist, gilt als „nicht gefunden“.
- Sie meldet Änderungen nicht von sich aus. Für aktuelle Daten fragen Sie die API in regelmäßigen Abständen ab: Die Seite „Einheiten, Vorzeichen und Datenaktualisierung“ nennt die Intervalle.
So erhalten Sie einen Client
Der API-Zugang wird nur auf ausdrückliche Anfrage freigeschaltet: Zugangsdaten können nicht selbst im Portal erstellt werden.
- Fordern Sie den Zugang bei zeroCO2 an, per E-Mail an info@energysynt.com unter Angabe Ihrer Organisation.
- Ein zeroCO2-Mitarbeiter legt einen API-Client für Ihre Organisation an und übergibt Ihnen eine
client_idund einclient_secret. - Bewahren Sie das Secret sofort in einem Secrets Manager auf: Es wird nur einmal, bei der Erstellung, angezeigt. Betten Sie es nie in clientseitigen Code ein, etwa in eine Webseite oder eine App.
Bei Verlust oder Offenlegung des Secrets fordern Sie bei zeroCO2 einen neuen Client an.
Standardmäßig erhält ein Client diese Berechtigungen (Scopes):
| Scope | Zugriff auf |
|---|---|
read:plants |
Anlagenliste und -details, Konnektivität |
read:telemetry |
Momentanleistung und Leistungsreihen |
read:energy |
Energiesummen und -reihen |
read:alarms |
aktive und historische Alarme |
Token enthalten außerdem read:controls; dieser Scope ist den Steuerfunktionen vorbehalten, die in dieser Version nicht aktiv sind.
Welche Anlagen der Client sieht
Der Client sieht genau die Anlagen, die mit Ihrer Organisation verknüpft sind. Die Liste erhalten Sie mit GET /v1/plants. Jede Anlage hat eine stabile Kennung, plant_id, die Sie in allen weiteren Aufrufen verwenden.
Erste Schritte
- Lassen Sie sich wie oben beschrieben einen Client anlegen.
- Folgen Sie „Authentifizierung und erster Aufruf“, um einen Token anzufordern und Ihre Anlagen aufzulisten.
- Lesen Sie „Limits, Fehler und Support“, bevor Sie die Integration in Betrieb nehmen.