Konfiguration

In den Einstellungen kannst du Allgemeine Einstellungen für den Client vergeben, wie zum Beispiel die Verbindungsdaten.

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

Host
Hier kannst Du die IP-/Web-Addresse des REST Services angeben.

Port
Hier kannst Du 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 kannst Du hier mitangeben. Z.B.: "/api".

Globale Header
Hier kannst Du 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" kannst Du 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 kannst Du auswählen ob die Authentifizierung über GET oder POST gesendet werden soll.
  • Login URL: Hier kannst Du einen Pfad für den Login wählen, dieser ist unabhängig von der Basis URL.
  • Header: Hier kannst Du Header für die Login Anfrage angeben. Diese müssen als JSON String angeben werden.
  • Token: Hier kannst Du angeben ob bei der Antwort vom REST Service der benötigte Token im Header gesendet wird oder im Body.
  • Position: Hier kannst Du die Position angeben an der der Token in der Antwort steht. Z.B.: "login-token" im Header.
  • Inkludieren in: Hier kannst Du angeben ob der ausgelesene Token bei weiteren Anfragen im Header oder im Body mitgesendet werden soll.
  • Position: Hier kannst Du die Position angeben an der der Token bei weiteren Anfragen eingefügt werden soll. Z.B.: "x-token" im Header.
  • Periodisch Einloggen: Hier kannst Du 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" kommst Du auf die Ansicht der Anfragen für den REST Client. Hier kannst Du neue Anfragen anlegen und bestehende bearbeiten.

Mit "Anfrage hinzufügen" kannst Du eine neue Anfrage erstellen.

In den Einstellungen von Anfragen kannst Du definieren was in der Anfrage gesendet werden soll.

Methode
Hier kannst Du auswählen mit welcher HTTP Methode die Anfrage gesendet werden soll.

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

Header
Hier kannst Du Header angeben welche mit der Anfrage mitgesendet werden sollen. Diese müssen als JSON String angegeben werden.

Body
Hier kannst Du angeben was im Body der Anfrage gesendet werden soll. Der Body muss als JSON String angegeben werden.

Zyklisch
Hier kannst Du angeben ob die Anfrage Zyklisch gesendet werden soll und in welchem Abstand.

Du kannst deine Anfrage mit "Anfrage schicken" senden, um zu testen ob alle Einstellungen richtig gesetzt sind und bekommst die Antwort angezeigt.