Geräte per RESTful verbinden
Über RESTful
Über RESTful können Sie HTTP Anfragen (GET, POST, PUT, DELTE) senden, um Ressourcen abzufragen. Eine Ressource kann alles sein, was Informationen enthält, z.B. Dokumente, Bilder oder Dienste.
Jede Ressource verfügt über eine eigene URL. Clients (z.B. Eliona) senden HTTP-Anfragen an diese URL. Als Antwort erhalten die Clients vom Server Status-Codes und Repräsentationen der angefragten Daten, meist als .json oder .xml.
In den meisten Fällen wird RESTful verwendet, um externe Geräte oder Dienste per GET-Request über deren API in Eliona einzubinden.
Was unterscheidet RESTful von Webhook?
Der bedeutendste Unterschied ist die Richtung der Kommunikation.
Mit RESTful sendet ein Client Anfragen an einen Server. Der Server antwortet mit einem Status-Code und (falls möglich) den angefragten Daten. Bei Kommunikation über RESTful muss die genaue Adresse des Servers, so wie der einzelnen Endpunkte bekannt sein.
Bei Webhook geht die Kommunikation vom Server aus. Der Server sendet aktiv und in Echtzeit Daten an den Client. Der Client muss keine Anfragen stellen. Bei einer Kommunikatiojn über Webhooks muss der Server die Adresse des Clients kennen.
Vorgehen
Das Vorgehen, um Geräte per RESTful einzubinden lässt sich in folgende Schritte unterteilen:
Zuerst wird eine Verbindung angelegt und konfiguriert. Diese Verbindung enthält die Basis-URL zu einer API.
In dieser Verbindung werden einzelne Requests angelegt. In diese Requests werden die einzelnen Parameter eingetragen, die abgefragt werden sollen.
Überblick
| Symbol | Beschreibung | Details |
|---|---|---|
[A] | Menü „Verbindungen“ | Klicken, um das Menü „Verbindungen“ aufzurufen |
[B] | Reiter | Zugriff auf die jeweiligen Schnittstellen |
[C] | Arbeitsbereich | Zeigt eine Liste der bestehenden Verbindungen an (wenn vorhanden) |
[D] | Verbindung | Eine bestehende Verbindung |
[E] | Requests einblenden/ausblenden | Klicken, um Requests, die dieser Verbindung zugeordnet sind einzublenden oder auszublenden |
[F] | Requests | Einzelne Requests |
[G] | Verbindung pausieren/wieder aufnehmen | Klicken, um eine Verbindung zu pausieren bzw. wieder zu starten |
[H] | Status der Verbindung | Zeigt den aktuellen Status der Verbindung an |
[I] | Name | Name der Verbindung |
[J] | URL | Die Basis-URL der jeweiligen Verbindung |
[K] | Requests | Zeigt an, wie viele Requests dieser Verbindung zugeordnet sind |
[L] | Request hinzufügen | Klicken, um der jeweiligen Verbindung einen Request hinzuzufügen |
[M] | Neue Verbindung | Klicken, um eine neue Verbindung zu erstellen |
[N] | Verbindungs-Details | Klicken, um die Details der jeweiligen Verbindung aufzurufen. Öffnet die ↗Verbindung-Details |
[O] | Verbindung löschen | Löscht die jeweilige Verbindung. ⚠ Achtung: Wenn die Verbindung auch in anderen Projekten genutzt wird, wird sie dort ebenfalls gelöscht. |
[P] | Request-Details | Klicken, um die Details des jeweiligen Requests zu bearbeiten. |
Neue Verbindung erstellen
Klicken Sie in der Seitenleiste auf Verbindung [A] ▷ Das Fenster „Verbindungen“ öffnet sich
Wählen Sie im Reiter RESTful [B] aus
Im Arbeitsbereich [C] wird eine Liste der bereits bestehenden Verbindungen [D] angezeigt ◈ Wenn Sie keine Einträge sehen, bestehen noch keine Verbindungen ◈ Es werden auch Verbindungen angezeigt, die in anderen Projekten konfiguriert wurden
Klicken Sie auf [M], um eine neue Verbindung aufzubauen ▷ Es öffnen sich das Fenster ↗ "RESTful Verbindung konfigurieren"
Fahren Sie fort in Kapitel ↗ "RESTful Verbindung konfigurieren"
Bestehende Verbindung bearbeiten
Klicken Sie in der Seitenleiste auf Verbindung [A] ▷ Das Fenster „Verbindungen“ öffnet sich
Wählen Sie im Reiter RESTful [B] aus
Im Arbeitsbereich [C] wird eine Liste der bereits bestehenden Verbindungen [D] angezeigt ◈ Wenn Sie keine Einträge sehen, bestehen noch keine Verbindungen ◈ Es werden auch Verbindungen angezeigt, die in anderen Projekten konfiguriert wurden
Klicken Sie auf [M], um eine neue Verbindung aufzubauen ▷ Es öffnen sich das Fenster ↗ "RESTful Verbindung konfigurieren"
Fahren Sie fort in Kapitel ↗ "RESTful Verbindung konfigurieren"
Last updated
