API-Key erstellen

Der API-Key wird in den Anlageneinstellungen des Portals erstellt. In diesem Bereich wird auch die benötigte Anlagen-ID angezeigt.

Wenn der Menüpunkt nicht sichtbar ist, muss der Installateur oder zuständige Portaladministrator den Key erstellen oder die Berechtigung prüfen.

API-Aufruf für Anlagen

Der Anlagenabruf erfolgt über den Pfad /api/pl. Die benötigten Werte werden als URL-Parameter übergeben. Der API-Key kann in verschiedenen Schreibweisen angegeben werden.

Parameter Beschreibung
APIkey / APIKey / apikey / api_key API-Key für die Authentifizierung.
plant_id / Anlagen_id Anlagenkennung; sie ist unter anderem in der Dashboard-URL enthalten.
from / to Zeitraum als Unix-Zeitstempel in UTC oder als Datum im Format TT.MM.JJJJ.
interval Leer für Anlageninformationen oder Werte wie 5mins, 15mins, daily, monthly, yearly.
type Datenbereich, zum Beispiel plant, device, sensor, inverter, meter, battery, wallbox oder stringbox.
Beispielstruktur: /api/pl?apikey=APIKEY&plant_id=1234&from=17.03.2024&to=17.04.2024&interval=daily

Antwortdaten

Ohne Intervall liefert der Abruf Anlageninformationen. Mit Intervall liefert er Zeitreihen beziehungsweise Datenpunkte für den gewünschten Bereich.

  • Anlageninformationen: Name, Anlagenleistung, Adresse, Jahressoll, Anlagen-ID, Land und Anlagenmerkmale.
  • Datenlisten: Zeitstempel und Wert je Datenpunkt.
  • Typische Werte: Ertrag, Verbrauch, Einspeisung, Bezug, Eigenverbrauch, Laden und Entladen.

Anfragen zählen

Die Zählweise der API-Anfragen hängt vom abgefragten Bereich und Intervall ab. Bei Anlageninformationen zählt jeder Abruf als Anfrage.

Bei Geräteabrufen mit 5- oder 15-Minuten-Intervallen wird jeder abgefragte Tag als Anfrage gewertet. Das sollte bei automatisierten Abfragen berücksichtigt werden.

Reseller- und Kundensummen

Für Reseller- oder Kundensummen können eigene Schlüssel verwendet werden. Der Abruf erfolgt ebenfalls über /api/pl, jedoch mit reseller_id oder customer_id und einem passenden API-Key.

Der Parameter interval bestimmt den Summenzeitraum. Unterstützt werden day, month, year und all.

Intervall Datenumfang
day Array mit 48 halbstündlichen Werten des aktuellen Tages.
month Alle Tage des aktuellen Monats.
year Alle Monate des aktuellen Jahres.
all Alle verfügbaren Jahre.
Datenpunkte werden je nach Kontext in Watt oder Wh geliefert; Summen werden in kWh angegeben.