PLEXLOG Portal-API

Technische Anleitung zum Abrufen von Anlagen-, Geräte- und Messdaten über die PLEXLOG Portal-API.

API-Key erstellen

Den API-Key erstellen Sie im PLEXLOG-Portal in den Anlageneinstellungen unter API-Key. Dort wird auch die benötigte Anlagen-ID angezeigt.

Ist der Menüpunkt nicht vorhanden, wenden Sie sich an den zuständigen Installateur. Dieser kann den API-Key für die Anlage erstellen.

Sicherheitshinweis: Behandeln Sie den API-Key wie ein Passwort. Veröffentlichen Sie ihn nicht in Tickets, Screenshots oder frei zugänglichem Quellcode.

Portal-API für Anlagen abrufen

Die API wird über den Pfad /api/pl des jeweiligen PLEXLOG-Portals aufgerufen. Die Parameter werden als Query-Parameter an die URL angehängt.

Parameter	Zulässige Werte	Bedeutung
`apikey`	`APIkey`, `APIKey`, `apikey` oder `api_key`	Der in den Anlageneinstellungen erzeugte API-Key.
`anlagen_id`	Numerische Anlagen-ID	Identifiziert die Anlage. Die Nummer ist auch in der URL des Anlagendashboards enthalten.
`from` / `to`	Unix-Zeitstempel in UTC oder Datum im Format `TT.MM.JJJJ`	Legt den abgefragten Zeitraum fest. Beispiel für einen Unix-Zeitstempel: `1577880000`.
`interval`	leer, `5mins`, `15mins`, `daily`, `monthly`, `yearly`	Bestimmt die zeitliche Auflösung. Ohne Intervall werden die Anlageninformationen ausgegeben.
`type`	`plant`, `device`, `sensor`, `inverter`, `meter`, `battery`, `wallbox`, `stringbox`	Grenzt die Abfrage auf den gewünschten Daten- oder Gerätetyp ein. `kwk` wird derzeit nicht unterstützt.

Beispielaufruf

https://<portal-host>/api/pl?apikey=<API-KEY>&plant_id=<ANLAGEN-ID>&from=17.03.2022&to=17.04.2022&interval=daily

Ersetzen Sie <portal-host>, <API-KEY> und <ANLAGEN-ID> durch die Werte der jeweiligen Anlage. Der Originalbeispielaufruf verwendet für die Anlagen-ID den Parameternamen plant_id.

Rückgabewerte

Ohne Zeitintervall liefert die API Anlageninformationen. Dazu gehören Name, Anlagenleistung, Straße, Hausnummer, Postleitzahl, Stadt, Jahressoll, Anlagen-ID, Land sowie Angaben dazu, ob es sich um eine PV-Anlage handelt und ob Verbrauch, Batterie oder Eigenverbrauch vorhanden sind.

Messdaten werden als Liste aus Zeitstempel und Wert zurückgegeben. Abhängig von Anlage und Abfrage können Ertrag, Verbrauch, Einspeisung, Bezug, Eigenverbrauch, Laden und Entladen enthalten sein.

Zählung der Anfragen

Anlage: Jeder Aufruf wird als eine Anfrage gezählt.
Gerät: Bei einem Intervall von 5 oder 15 Minuten wird jeder abgefragte Tag als eine Anfrage gezählt.

Portal-API für Reseller- und Kundensummen

Summenwerte können mit einem Reseller- oder Kunden-Key abgefragt werden.

Abfrage	URL-Schema
Reseller-Key	`/api/pl?reseller_id=<ID>&api_key=<API-KEY>&interval=day\|month\|year\|all`
Kunden-Key	`/api/pl?customer_id=<ID>&api_key=<API-KEY>&interval=day\|month\|year\|all`

Intervall	Ausgabe
`day`	Array mit 48 Einträgen; jeder Eintrag entspricht einer halben Stunde des aktuellen Tages.
`month`	Alle Tage des aktuellen Monats.
`year`	Alle Monate des aktuellen Jahres.
`all`	Alle Jahre.

Die Datenpunkte werden in Watt beziehungsweise Wattstunden ausgegeben; Summen werden in Kilowattstunden angegeben.