System-Interaktion per HTTP (REST API)

Lobster_data bietet eine Reihe von Möglichkeiten System-Einstellungen per HTTP vorzunehmen, Vorgänge zu starten, bzw. Informationen aus dem System auszulesen.


Swagger/OpenAPI


Auf der folgenden Seite wird eine Swagger-/OpenAPI-Schnittstellenbeschreibung 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 Partnerverwaltung per HTTP benutzen (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


images/download/attachments/69046799/1307-version-2-modificationdate-1668746969239-api-v2.png

images/download/attachments/69046799/1308-version-1-modificationdate-1668747718700-api-v2.png

images/download/attachments/69046799/1309-version-1-modificationdate-1668747718702-api-v2.png

images/download/attachments/69046799/1310-version-1-modificationdate-1668747718707-api-v2.png

images/download/attachments/69046799/1311-version-1-modificationdate-1668747718710-api-v2.png


(1) Es ist eine Anmeldung per Basic Authentication mit einem Lobster_data-Benutzer mit Admin-Rechten notwendig.

(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.

Tools


OpenAPI

Integriert in Lobster_data. Siehe oben.

Postman

Als externe Software kann z. B. Postman benutzt werden. Anleitungen finden Sie dort und auf vielen anderen Seiten.

Eigene REST-Schnittstelle/API aufbauen


Wie bereits erwähnt, kann auch ein Profil mit einem HTTP-Eingangsagenten 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.