Mit dem REST API Adapter können HTTP RESTful API Web Service Aufrufe durchgeführt werden. Es werden die Standard Methoden GET, POST, PUT, PATCH und DELETE unterstützt. Der REST API Adapter kann sowohl auf der READ wie auch auf der WRITE Seite verwendet werden.
Der REST API Adapter kann individuell auf jede beliebige Anfrage angepasst werden. Über gestapelte Verarbeitungsschritte können Anfragen dynamisch abgeschickt und automatisiert ausgewertet werden, siehe Beispiele weiter unten.
Reiter Allgemein
REST Adapter AllgemeinAuf dem Reiter Allgemein findet die Standard Konfiguration statt. Hier geben Sie an welche URL über welche Methode aufgerufen werden soll, sowie ob eine Anmeldung am Webserver stattfinden soll.
URL: Die URL die aufgerufen werden soll.
Methode: Die HTTP Methode die verwendet werden soll. Es stehen die Methoden „GET, POST, PUT, PATCH und DELETE“ zur Verfügung.
Content Type: Wird hier eine Angabe gemacht wird im HTTP „Content Header“ die Header Variable „Content-Type“ auf diesem Typ, unter Verwendung des angegebenen Encodings (Charset), gesetzt.
z.B. „Content-Type: application/json; charset=utf-8“.
Hinweis: Die HTTP ContentHeader/RequestHeader Variable „Content-Type“ kann auch dynamisch über die Adapter Felder gesetzt werden, siehe Reiter „Felder / Datentypen“.
Daten: Der zu sendende Request Content. Im Normalfall bei HTTP Methode „POST“. Der Request Content kann auch dynamisch über die Adapter Felder gesetzt werden, siehe Reiter „Felder / Datentypen“.
Achtung: Wenn Sie den REST API Aufruf über den Button „Testen“ aufrufen, wird der Aufruf an den Web Server übermittelt. Für Tests sollten Sie hier unbedingt eine eigenständige Test URL verwenden, nicht dass ungewollt produktive Daten geändert, hinzugefügt oder gelöscht werden!
Anmeldung
Der REST Adapter unterstützt u.a. auch eine Benutzer Anmeldung am Web Server per Benutzer/Passwort Kombination sowie über ein im Windows Zertifikatsspeicher hinterlegtes Benutzer Zertifikat. Hinweis: Für eine Zertifikatsanmeldung muss ein privater Schlüssel im Zertifikat hinterlegt sein!
Reiter Felder/Datentypen
REST Adapter - Felder und DatentypenÜber diesen Reiter können Sie dynamisch Werte setzen oder aber abrufen, je nachdem auf welcher Seite „READ“ bzw. „WRITE“ der REST API Adapter verwendet wird.
Feldtyp: Über den Feldtyp legen Sie fest, welche Wert im REST API Aufruf gesetzt bzw. angerufen werden soll. Es stehen folgende Optionen zur Verfügung.
URL: Überschreibt die auf dem Reiter „Allgemein“ gemachte Angabe.
Agent: Setzt die „Request Header“ Variable “User-Agent” auf diesen Wert.
HTTP_STATUS: Der vom Web Server gelieferte Status als Text, z.B. OK, Accepted, Not Found, …
HTTP_STATUS_CODE: Der vom Web Server gelieferte Status Code, z.B. 200, 202, 404, …
RequestDateTime: Datum und Uhrzeit der Anfrage
RequestHeader: Setzt eine HTTP HEADER Variable „Name=Feldname“ mit dem aktuellen Inhalt des Feldes.
RequestContent: Übermittelt den Inhalt des Feldes als Content. Überschreibt den auf dem Reiter „Allgemein“ unter „Daten“ angegebenen Inhalt!
RequestContentHeader: Setzt eine HTTP CONTENT HEADER Variable „Name=Feldname“ mit dem aktuellen Inhalt des Feldes.
ResponseDateTime: Datum und Uhrzeit der Antwort vom Web Server.
ResponseHeader: Abfrage der vom Web Server gelieferten HTTP RESPONSE HEADER Variablen. Ist die Option „Anhand Feldnamen zurückgegeben“ deaktiviert werden alle gelieferten HEADER Variablen inkl. Namen zurückgegeben!
ResponseContent: Der vom Web Server gelieferte Content. z.B. JSON, XML, HTML, etc.
ResponseContentHeader: Abfrage der vom Web Server gelieferten HTTP RESPONSE CONTENT HEADER Variablen. Ist die Option „Anhand Feldnamen zurückgegeben“ deaktiviert werden alle gelieferten CONTENT HEADER Variablen inkl. Namen zurückgegeben!
Reiter Erweitert
REST Adapter - ErweitertAnfrage Timeout: Definiert die Zeitspanne die max. auf eine Antwort vom REST Web Service gewartet werden soll. Die Angabe hier ist in Millisekunden vorzunehmen.
Überprüfe SSL/TLS Zertifikate: Ist diese Option aktiviert wird das vom Web Server gelieferte Zertifikat validiert. Hinweis: Diese Option sollte nur in Ausnahmefällen deaktiviert werden!
Lese von: Wird der REST API Adapter auf der WRITE Seite verwendet kann hierüber in einem nachfolgenden Verarbeitungsschritt zugegriffen werden. Es werden so im Nachgang alle gemachten REST Web Service Anfragen gelesen und der Status bzw. gelieferte Inhalt zu jeder Anfrage kann verarbeitet werden.
Reiter Format
Der Reiter Format wird genauer im allgemeinen Kapitel für Adapter beschrieben.
Folgende Beispiele stehen für den REST API Adapter zur Verfügung
- Support Forums Artikel
- Weitere Beispiele werden in Kürze folgen
