Werbung
• REST-API
Die Rest-API ermöglicht es dem Benutzer, Online-/Verlaufswerte direkt von der Steuereinheit abzurufen,
ohne auf die Web-UI zuzugreifen. Sie kann vom Administrator in diesem Abschnitt aktiviert/deaktiviert
werden: Um auf Daten über die REST-API zuzugreifen, muss in jeder Anfrage ein Berechtigungs-Token im
Berechtigungs-Header angegeben werden. Das Token muss auf dieser Seite generiert werden oder es
können Administrator-Anmeldeinformationen verwendet werden.
Die höchste Nummer, die über die REST-API korrekt abgerufen werden kann, ist 2⁵³-1 (9007199254740991)
Achtung: Die REST-API ist standardmäßig aktiviert. Wenn sie nicht verwendet wird, kann sie
deaktiviert werden.
DER AUTORISIERUNGS-HEADER MUSS FÜR JEDE REST-API-ANFORDERUNG GESENDET WERDEN.
Berechtigung: <restApiToken>
oder
Berechtigung: Basic YWRtaW46YWRtaW4=
(YWRtaW46YWRtaW4= Token aus Admin-Anmeldeinformationen codiert - base64 Benutzername:Passwort)
VERFÜGBARE REST-API-ENDPUNKTE:
GET
/api/v1/system-information
Der Endpunkt gibt Systeminformationen zurück, die für Diagnosezwecke verwendet werden können
Antwort:
{
„Software-Version": „1.0.0",
„IP": „192.168.1.200",
„Hostname": „scu200hs",
„Gerätezeit": 1669793245
}
GET
/api/v1/metadata
oder
/api/v1/metadata?object_id=X
Zum Abrufen von Metadaten für ein einzelnes Gerät
Endpunkt gibt Systemgeräte-Metadaten zurück, die alle konfigurierten Geräte mit verfügbaren Registern
enthalten.
POST
/api/v1/data
Mit dem Endpunkt können Online- und Verlaufsdaten von der SCU200 abgerufen werden.
Variablen müssen in einem JSON-Body einer POST-Anfrage bereitgestellt werden. Sie können aus
Gerätedeskriptoren oder Metadaten-Endpunkten gelesen werden. Objekt-IDs können vom Metadaten-
Endpunkt gelesen werden.
{
//„data": Array von Objekten, es können mehrere Daten gleichzeitig abgefragt werden
"data": [
{
SCU200 INSITE ENERGIEMANAGEMENTSYSTEM
67
Werbung
