Geräte über RESTful verbinden
Über RESTful
Mit RESTful können Sie HTTP-Anfragen (GET, POST, PUT, DELETE) senden, um Ressourcen. Eine Ressource kann alles sein, was Informationen enthält, z. B. Dokumente, Bilder oder Dienste.
Jede Ressource hat ihre eigene URL. Clients (z. B. BuildingPro Suites) senden HTTP-Anfragen an diese URL. Als Antwort erhalten Clients Statuscodes und Repräsentationen der angeforderten Daten vom Server, normalerweise als .json oder .xml.
In den meisten Fällen wird RESTful verwendet, um externe Geräte oder Dienste über ihre API per GET-Anfrage in BuildingPro Suites zu integrieren.
Was ist der Unterschied zwischen RESTful und Webhook?
Der wesentlichste Unterschied ist die Richtung der Kommunikation.
Bei RESTful sendet ein Client Anfragen an einen Server. Der Server antwortet mit einem Statuscode und (wenn möglich) den angeforderten Daten. Für die Kommunikation über RESTful müssen die genaue Adresse des Servers sowie die einzelnen Endpunkte bekannt sein.
Bei Webhook geht die Kommunikation vom Server aus. Der Server sendet aktiv in Echtzeit Daten an den Client. Der Client muss keine Anfragen senden. Für die Kommunikation über Webhooks muss der Server die Adresse des Clients kennen.
Vorgehen
Das Verfahren zur Integration von Geräten über RESTful kann in die folgenden Schritte unterteilt werden:
Zuerst wird eine Verbindung erstellt und konfiguriert. Diese Verbindung enthält die Basis-URL zu einer API.
In dieser Verbindung werden einzelne Anfragen erstellt. In diese Anfragen werden die einzelnen Parameter eingetragen, die abgefragt werden sollen.
Übersicht
[A]
Menü „Verbindungen“
Klicken Sie, um das Menü „Verbindungen“ zu öffnen
[B]
Registerkarte
Zugriff auf die jeweiligen Schnittstellen
[C]
Arbeitsbereich
Zeigt eine Liste der vorhandenen Verbindungen an (falls vorhanden)
[D]
Verbindung
Eine vorhandene Verbindung
[E]
Anfragen ein-/ausblenden
Klicken Sie, um die dieser Verbindung zugewiesenen Anfragen ein- oder auszublenden
[F]
Anfragen
Einzelne Anfragen
[G]
Verbindung pausieren/fortsetzen
Klicken Sie, um eine Verbindung zu pausieren oder fortzusetzen
[H]
Verbindungsstatus
Zeigt den aktuellen Status der Verbindung an
[I]
Name
Name der Verbindung
[J]
URL
Die Basis-URL der jeweiligen Verbindung
[K]
Anfragen
Zeigt an, wie viele Anfragen dieser Verbindung zugeordnet sind
[L]
Anfrage hinzufügen
Klicken Sie, um der jeweiligen Verbindung eine Anfrage hinzuzufügen
[M]
Neue Verbindung
Klicken Sie, um eine neue Verbindung zu erstellen
[N]
Verbindungsdetails
Klicken Sie, um die Details der jeweiligen Verbindung zu öffnen. Öffnet die ↗Verbindungsdetails
[O]
Verbindung löschen
Löscht die jeweilige Verbindung. ⚠ Vorsicht: Wenn die Verbindung auch in anderen Mandanten verwendet wird, wird sie dort ebenfalls gelöscht.
[P]
Anfragedetails
Klicken Sie, um die Details der jeweiligen Anfrage zu bearbeiten.
Neue Verbindung erstellen
Klicken Sie in der Seitenleiste auf Verbindung [A]
▷ Das Fenster "Verbindungen" öffnet sich
Wählen Sie den RESTful [B] Tab
Im Arbeitsbereich [C], eine Liste der bereits vorhandenen Verbindungen [D] angezeigt
◈ Wenn Sie keine Einträge sehen, sind noch keine Verbindungen vorhanden
◈ Verbindungen, die in anderen Mandanten konfiguriert wurden, werden ebenfalls angezeigt
Klicken Sie auf [M] um eine neue Verbindung herzustellen
▷ Die ↗ „RESTful-Verbindung konfigurieren“ Fenster öffnet sich
Weiter im Kapitel ↗ „RESTful-Verbindung konfigurieren“
Vorhandene Verbindung bearbeiten
Klicken Sie in der Seitenleiste auf Verbindung [A]
▷ Das Fenster "Verbindungen" öffnet sich
Wählen Sie den RESTful [B] Tab
Im Arbeitsbereich [C], eine Liste der bereits vorhandenen Verbindungen [D] angezeigt
◈ Wenn Sie keine Einträge sehen, sind noch keine Verbindungen vorhanden
◈ Verbindungen, die in anderen Mandanten konfiguriert wurden, werden ebenfalls angezeigt
Klicken Sie auf [M] um eine neue Verbindung herzustellen
▷ Die ↗ „RESTful-Verbindung konfigurieren“ Fenster öffnet sich
Weiter im Kapitel ↗ „RESTful-Verbindung konfigurieren“
Zuletzt aktualisiert
War das hilfreich?