Rest Client

Mit der App "REST Client" können Sie auch Funktionen auf Geräten auslösen, für welche es keine eigene evon Smart Home App gibt, welche jedoch über eine REST Schnittstelle verfügen.

Für die Verwendung von REST benötigen Sie ein Verständnis für die Funktionsweise von REST und die Schnittstellen die Ihnen das Gerät bietet, welches Sie anbinden wollen.
Eine kurze Beschreibung zu REST finden Sie hier.

Sie finden die "REST Client" App unter Alle Apps.

Erstellen

Um einen neuen REST Client zu erstellen, navigieren Sie zur App und wählen Sie "Client hinzufügen".

Konfiguration

In den Einstellungen können Sie Allgemeine Einstellungen für den Client vergeben, wie zum Beispiel die Verbindungsdaten.

Verbindung
HTTP / HTTPS
Hier können Sie angeben ob der REST Service über eine Verschlüsselte Verbindung (HTTPS) zur Verfügung steht oder nicht.

Host
Hier können Sie die IP-/Web-Addresse des REST Services angeben.

Port
Hier können Sie den Port des REST Services angeben.

Basis URL
Viele REST Services haben einen fixen Basis Pfad von welchem ausgehend alle weiteren Anfragen angehängt werden, diesen können Sie hier mitangeben. Z.B.: "/api".

Globale Header
Hier können Sie Header angeben welche mit jeder Anfrage mitgesendet werden sollen. Diese müssen als JSON String angegeben werden.

Authentifizierung
Es gibt drei vorhandene Authentifizierungsmethoden welche unterstützt werden: keine, Basic, Benutzerdefiniert.

keine
Wenn "keine" gewählt ist wird keine Authentifizierung vor dem Senden von Anfragen geschickt.

Basic
Bei "Basic" können Sie einen Benutzernamen und ein Passwort mitschicken. Diese Authentifizierungsmethode kann gewählt werden wenn der REST Service Basic Authentifizierung unterstützt.

Benutzerdefiniert
Für andere Authentifizierungsmethoden gibt es die Möglichkeit einer Benutzerdefinierten Authentifizierung.

  • Methode: Hier können Sie auswählen ob die Authentifizierung über GET oder POST gesendet werden soll.
  • Login URL: Hier können Sie einen Pfad für den Login wählen, dieser ist unabhängig von der Basis URL.
  • Header: Hier können Sie Header für die Login Anfrage angeben. Diese müssen als JSON String angeben werden.
  • Token: Hier können Sie angeben ob bei der Antwort vom REST Service der benötigte Token im Header gesendet wird oder im Body.
  • Position: Hier können Sie die Position angeben an der der Token in der Antwort steht. Z.B.: "login-token" im Header.
  • Inkludieren in: Hier können Sie angeben ob der ausgelesene Token bei weiteren Anfragen im Header oder im Body mitgesendet werden soll.
  • Position: Hier können Sie die Position angeben an der der Token bei weiteren Anfragen eingefügt werden soll. Z.B.: "x-token" im Header.
  • Periodisch Einloggen: Hier können Sie angeben ob ein periodischer Login erfolgen soll und in welchem Abstand.

Damit die Einstellungen übernommen werden muss der Button "Einstellungen übernehmen" gedrückt werden.

Über den Button "Anfragen bearbeiten" kommen Sie auf die Ansicht der Anfragen für den REST Client. Hier können Sie neue Anfragen anlegen und bestehende bearbeiten.

Mit "Anfrage hinzufügen" können Sie eine neue Anfrage erstellen.

In den Einstellungen von Anfragen können Sie definieren was in der Anfrage gesendet werden soll.

Methode
Hier können Sie auswählen mit welcher HTTP Methode die Anfrage gesendet werden soll.

Url
Hier können Sie angeben auf welchen Pfad die Anfrage gesendet werden soll. Dieser wird dann zusätzlich zum Host und Basis Pfad angehängt.

Header
Hier können Sie Header angeben welche mit der Anfrage mitgesendet werden sollen. Diese müssen als JSON String angegeben werden.

Body
Hier können Sie angeben was im Body der Anfrage gesendet werden soll. Der Body muss als JSON String angegeben werden.

Zyklisch
Hier können Sie angeben ob die Anfrage Zyklisch gesendet werden soll und in welchem Abstand.

Sie können Ihre Anfrage mit "Anfrage schicken" senden, um zu testen ob alle Einstellungen richtig gesetzt sind und bekommen die Antwort angezeigt.

Bedienung

In der Bedienung des REST Clients werden Ihnen die Anfragen angezeigt und können gleich gesendet werden.

Auch unter "Anfragen bearbeiten" können Sie die Anfragen senden.

Außerdem können die Anfragen auch an anderen Stellen Ihres evon Smart Home verwendet werden, wie zum Beispiel in den Szenen.