REST Client

<< Click to Display Table of Contents >>

Navigation:  Komponenten > Treiber >

REST Client

Diese Komponente dient zur Abfrage von REST API Servern

Für Entwickler - kein kostenfreier Support!

Im Unterkapitel befinden sich Beispiele für die Anbindung von Netatmo, EcoFlow River2 Pro und ChatGPT.

 

Datenpunkte der Komponente:

Name

Typ

Funktion

Diagnose [Text]

Ausgang

Hier werden Fehlermeldungen ausgegeben. Verbunden mit dem Eingang [Signal] des Protokollfensters werden dort die Diagnoseinformationen angezeigt.

Dynamisch

Ordner

Dieser Ordner beinhaltet die Abfrageparameter, sowie die Antwort. Im Ordner für den angelegten Kanal befinden sich die Datenpunkte für den Endpunkt abfragen-Trigger und für den Antwort Status-Code (siehe HTTP-Fehlercode).

Erweiterte Diagnose

Eingang

(De)Aktiviert die erweiterte Debug-Ausgabe. Achtung: Diagnose oder Debug - Ausgängen sind nur für den Fehlerfall vorgesehen. Bitte nur mit Rücksprache mit dem Supportteam verwenden! Diese können bei Verwendung die Leistung des Dienstes erheblich beeinträchtigen

Treiber An/Aus

Bidirektional

Schaltet den Treiber An oder Aus

 

 

Eigenschaften der Komponente

Name

Standard

Funktion

Verbindung

 

Einstellungen für die Verbindung zum REST Endpunkt (siehe unten).

Parameter-Profile

0

Über selbstdefinierte Profile ist es möglich, JSON-Strings, welche von einem REST Server gelesen werden, in einzelne Unter-Datenpunkte entsprechend der Hierarchie aufzusplitten. Ein separater JSON-Parser ist somit nicht mehr nötig. Über den Wizzard kann der gesamte JSON-String automatisch konvertiert werden. Hierfür wird auch ein Datenpunkt angelegt, damit dieser Parameter auch zur Laufzeit geändert werde kann.

Antwort-Profile

0

Über selbstdefinierte Profile ist es möglich, JSON-Strings die in einem REST Server übertragen werden, in einzelne Unter-Datenpunkte entsprechend der Hierarchie aufzusplitten. Ein separater JSON-Parser ist somit nicht mehr nötig. Über den Wizzard kann der gesamte JSON-String automatisch konvertiert werden. Über "Kanäle" --> "Datenpunkte lesen" wird das Profil automatisch erstellt.

Kanäle

0

Name: eigene Bezeichnung
Path: Angabe des Abfrage-Pfad (z.B. /api/device)
Request Type: Lesen, schreiben, löschen oder setzen
Query Format: Definiert das Format der Abfrage

Parameter-Profil: Auswahl des Parameter Profil
Antwort-Profil: Anzeige für das Ergebnis aus "Read Datapoint"
Endpunkt abfragen: Löst eine Abfrage aus. Es kann automatisch ein Antwort-Profil erzeugt werden.
Intervall: Einstellung für eine zyklische Abfrage in Sekunden.

Treiber An/Aus

 

Schaltet den Treiber bei Serverstart Ein oder Aus.

 

 

Hinweis: Endpunkt = Basis URL aus Common + Eintrag beim Path

 

Verbindung Common (Basis-Einstellung)

Name

Funktion

API Base-URL:

Angabe der Basis URL für den Abfrage-Endpunkt. Beispiel: https://api.domain.com/rest

Timeout [s]:

Angabe der Zeit, ab wann ein Timeout erkannt wird.

Headers:

Im Header werden zusätzliche Informationen für die Abfrage übertragen. Hierbei gilt die Schreibweise: Name=Wert und eine Zeile entspricht einem Parameter.

User:

Benutzername für die Anmeldung.

Password:

Passwort für die Anmeldung.

 

Verbindung OAuth2

Name

Funktion

Authentifizierung

Auswahl der OAuth Authentifizierungsmethode (muss bekannt sein).

Scopes

In OAuth2 bezeichnen Scopes (Bereiche) die Berechtigungen, die eine Anwendung anfordert, um auf bestimmte Ressourcen eines Benutzers oder einer API zuzugreifen. Gibt es mehrere können diese hintereinander geschrieben werden (Leerzeichen als Trennung)

Autorisierungs-Pfad

URL-Pfad zur Autorisierung. Dies wird benötigt um sich am System anmelden zu können. Beispiel: /oauth2/authorize (Ergibt mit der Base-URL: https://api.domain.com/rest/oauth2/authorize )

Token Pfad

URL zum Token Endpunkt. Hierdurch erhält man den Access-Token. Beispiel: /oauth2/token (Ergibt mit der Base-URL: https://api.domain.com/rest/oauth2/token )

Client ID

Identifizierung des Clients (Benutzername) für die Anmeldung an einem Backend.

Client Secret

Passwort/Secret key für die Anmeldung am Backend.

Authentifizierung durchführen

Durch diesen Button wird ein Anmeldeversuch gestartet.

Access Token

Bei erfolgreicher Anmeldung wird der Token automatisch gesetzt.

Refresh Token

Bei erfolgreicher Anmeldung wird der Token automatisch gesetzt.