REST API
Es gibt eine Reihe von Möglichkeiten System-Einstellungen per REST-API (HTTP) vorzunehmen, Vorgänge zu starten, bzw. Informationen aus dem System auszulesen.
Authentifizierung
Jeder Request erfordert eine Authentifizierung. Dazu benötigen Sie den Anmeldename und das Passwort eines Benutzers mit dem Benutzer-Recht Administrator oder Administration via REST.
Die Authentifizierung kann entweder über Basic Authentication (also im Header) erfolgen. Alternativ dazu können die Benutzerdaten in der URL mit &user=myuser&passwd=mypassword übergeben werden.
Ist LDAP aktiviert, können Sie zusätzlich zum allgemeinen Fallback-User einen REST-Fallback-User angeben.
Wichtiger Hinweis: Bei HTTP-Profilen läuft die Authentifizierung anders (siehe dort) und beim System Monitoring gibt es eine weitere Möglichkeit (siehe dort).
Swagger/OpenAPI
Unter foldender URL wird eine Swagger-/OpenAPI-Schnittstellenbeschreibung der REST-API im JSON- und YAML-Format bereitgestellt (siehe Dokumentation dort).
|
https://<URL oder IP des Integration Servers>/dw/spi/oas/v1/api |
|
Eintrag |
Bezug |
|
System Monitoring |
Bezieht sich auf Abschnitte |
|
MQTT |
Bezieht sich auf MQTT-Verbindungen. |
|
Remote Control |
Bezieht sich auf Abschnitte |
|
Partner Management |
Bezieht sich auf Abschnitt Partner (REST API). |
|
Statemachine (Workflow) |
Bezieht sich auf Abschnitt Workflows per HTTP benutzen (REST API). |
|
(HTTP-Eingangsagenten) |
Zudem können entsprechende Schnittstellenbeschreibungen auch für individuelle HTTP-Eingangsagenten bereitgestellt werden. Hinweis: Die URL ist hier abweichend von den anderen Einträgen, siehe Beschreibung im Eingangsagenten. |
Ansicht
(1) Es ist eine Authentifizierung notwendig (siehe Abschnitt oben).
(2) Klicken Sie hier.
(3) Wählen Sie die Werte für die Parameter.
(4) Klicken Sie hier. Danach bekommen Sie darunter den Request und die Response angezeigt.
Externe Tools
Eigene REST-Schnittstelle/API aufbauen
Ein Profil mit einem HTTP-Eingangsagenten kann als REST-Schnittstelle fungieren. Der Request-Suffix wird in der System-Variable MSG_CALL_HTTP_PATH_DATA gespeichert. Wenn Sie diese Variable auswerten, können Sie unterschiedliche Aktionen ausführen. In einem einfachen Fall könnten Sie also z. B. beim Request-Suffix add zwei per Request-Parameter übergebene Werte addieren oder beim Request-Suffix subtract entsprechend subtrahieren. Sie können aber natürlich auch beliebige andere (und komplexere) Aktionen anstoßen. Zum Beispiel verschiedene Workflows oder Folge-Profile anstoßen oder Sub-Profile aufrufen. Damit kann ein HTTP-Profil als Dispatcher Ihrer eigenen REST-API aufgebaut werden, Sie können aber wahlweise auch beliebig viele solcher HTTP-Profile aufbauen.