Inbetriebnahme HTTP-API / REST-API
Übersicht
HTTP-/REST-API ist die Bezeichnung für Datenaustausch über das HTTP-Protokoll.
Weitere gängige Bezeichnungen sind
Webhook
HTTP-API
RESTful Schnittstelle
REST-API
In allen Fällen handelt es sich um eine bidirektionale Client-Server-Kommunikation, die stets vom Client initiiert wird.
Der Timberwolf Server kann als HTTP-Client und / oder als HTTP-Server genutzt werden.
Diese Kommunikation ist zustandslos, das bedeutet, dass auf eine Anfrage (“Request”) eine Antwort (“Response”) zurückgesendet wird und der Vorgang damit abgeschlossen ist. Weitere Kommunikation benötigt einen erneuten Verbindungsaufbau mit Request-Response.
Timberwolf Server als HTTP-Client
Alle Modelle des Timberwolf Servers unterstützen die Kommunikation über HTTP-API / REST-API mit externen Servern ab Firmware V 3.0.
Der Timberwolf Server ist in dieser Betriebsart der HTTP-Client, der Anfragen an externe HTTP-Server richtet.
Es können mehrere Subsystem-Instanzen als HTTP-Client eingerichtet werden.
Timberwolf Server als HTTP-Server
Alle Modelle des Timberwolf Servers unterstützen die Kommunikation über HTTP-API / REST-API als HTTP-Server ab Firmware IP 8 zur V 4.5 (oder neuer).
Der Verbindungsaufbau wird jeweils durch externe Clients zum Timberwolf Server hin initiiert.
Es kann nur EINE Subsystem-Instanz als HTTP-Server eingerichtet werden.
Firmware Die Funktion als HTTP-Server steht ab IP8 zur V 4.5 oder neuer zur Verfügung.
weitere DOKU Eine umfangreiche Doku zum neuen Subsystem “HTTP-/REST-API als Server” gibt es auch im Forum unter https://forum.timberwolf.io/viewtopic.php?t=5985https://forum.timberwolf.io/viewtopic.php?t=5985
ekey new generation Mit dem neuen Subsystem HTTP-Server kann nun auch ekey s/x/d-Line (die neue Generation) mit dem Timberwolf Server genutzt werden. Für die Konfiguration lesen Sie bitte diese Anleitung im Forum: https://forum.timberwolf.io/viewtopic.php?f=85&t=5994
Übersicht Leistungsmerkmale
Keine Begrenzungen: Die Anzahl der unterstützten Datenpunkte oder die Zahl der ansprechbaren Server und Geräte ist nicht künstlich begrenzt. Es werden die üblichen Datenformate unterstützt. Die Werte können nahezu beliebig mit den Objekten anderer unterstützter Technologien (je nach Server-Modell, Ausstattung, Firmwareversion und Lizenz z.B. MQTT, KNX, 1-Wire, ekey, Zeitserien mit Grafana, DMX, Modbus, anderen HTTP-API Ressourcen, IFTTT, Logik Engine usw.) verknüpft werden.
Einfache Konfiguration: Die Einrichtung erfolgt über eine einfach bedienbare grafische Benutzeroberfläche mit kontextsensitiven Einrichtungsassistenten. Für jeden Eingabeschritt werden Hilfetexte eingeblendet. Auf Knopfdruck steht dieses Wiki zur Verfügung.
Integrierte Diagnose: Datenmonitore und und interaktiven Statusanzeigen unterstützen bei Einrichtung neuer HTTP-/REST-API Ressourcen bzw. Endpunkten sowie bei der Fehlersuche.
Inhalt dieses Kapitels
In Kürze finden Sie hier zusätzliche Informationen zu den Leistungsmerkmalen, der Inbetriebnahme und der Nutzung des Leistungsmerkmales HTTP-/REST-API mit dem Timberwolf Server.