Entwickler API Dokumentation

Diese Dokumentation soll Ihnen als Kunde helfen, Ihre PV-Anlage und Geräte in Ihr bestehendes Smart-Home System einzubinden.

Durch unsere API Schnittstelle haben Sie die möglichkeit, Ihre PV-Anlage und Geräte in Ihr bestehendes Smart-Home einzubinden. Dadurch erhalten Sie die möglichkeit, automatische Prozesse zu entwickeln.

Die API wird ständig weiterentwickelt. Im moment erhalten Sie folgende Informationen:

  • Aktuelle Ertragswerte Ihrer PV-Anlage
  • Aktueller Hausverbrauch (Smart-Meter vorausgesetzt)
  • Status Ihrers Wechselrichters und der Batterie
  • Aktueller Stromfluss Ihrer PV-Anlage (Wechselrichter, Batterie, Hausverbrauch)
Die API Schnittstelle kann über HTTPS (POST) angesprochen werden. Hierfür benötigen Sie einen API Schlüssel. Diesen erhalten Sie von uns per E-Mail. Eine einfache Anfrage mit Ihrer Kundennummer reicht. Alle Daten werden als JSON Objekt zurück geliefert.

Der Aufbau der Anfrage an unseren Server sieht folgendermaßen aus:

URL: https://customerapi.uset-gmbh.de?key=APIKEY&action=ACTION
APIKEY
: Ihren API-Key
ACTION: Welche Daten Sie erhalten möchten

Je nachdem, ob die Anfrage erfolgreich oder Fehlerhaft war, erhalten Sie als Rückgabe folgende Anwort im JSON Format:

code: Statuscode, siehe Statuscode
time: Timestamp Aktueller UNIX Zeitstempel
message: Nachricht Weitere Informationen
data: Dynamische Daten Die Angeforderte Daten Ihres Requests

Beispiel eines Requests / Anfrage:
https://customerapi.uset-gmbh.de?key=3132hsdsdf96202ds3228&action=livedata

Als Response / Antwort erhalten Sie:
{ code: 200, time: 1715691253, message: "ok", data: { currentW: 8374, currentV: 1843, currentA: 9 }}