Connector-Anruf-Assistent
Der Simplifier REST Connector Call Wizard bietet die automatische Generierung von Calls über die OpenAPI 3 Specification.
Abrufen der OpenAPI-URL
Sie können OpenAPI-Marktplätze wie
- SwaggerHub (https://app.swaggerhub.com/search)
- API-Guru (https://apis.guru/)
Erstellen von Konnektoraufrufen über den Assistenten
Im folgenden Video finden Sie eine Schritt-für-Schritt-Anleitung
In der Übersicht über Connector-Anrufe finden Sie den Connector Wizard in der oberen rechten Ecke.
Schritt 1: Festlegen der OpenAPI-URL Legen Sie die OpenAPI-URL fest, die der Assistent analysieren soll, um die Connector-Aufrufe zu erstellen.
Schritt 2: Wählen Sie Anrufe Als nächstes können Sie die Anrufe auswählen, die erstellt werden sollen.
Verschieben Sie Ihre ausgewählten Anrufe mit dem Pfeilsymbol in den rechten Bereich.
Klicken Sie dann auf “Weiter”.
Schritt 3: Bearbeiten der Connector-Aufrufe Nachdem Sie die gewünschten Anrufe ausgewählt haben, können Sie auf dem nächsten Bildschirm deren Namen und Beschreibungen bearbeiten.
Wenn Sie die Anrufe bearbeitet haben, klicken Sie auf “Connectorcalls erstellen”.
Standardkonfiguration
In diesem Abschnitt werden die erforderlichen Parameter und Datentypen für die manuelle Konfiguration von REST Connector-Aufrufen beschrieben.
Es gibt vier Registerkarten: ‘Allgemein’, ‘Pfad’, ‘Abfrageparameter’, ‘Kopfzeile’.
Allgemein
Hier können Sie die grundlegenden Eigenschaften für Ihren Connector-Aufruf konfigurieren.
Verb
| HTTP-Verb-Beschreibung | |
| GET | entspricht ‘read’. |
| BEREITSTELLEN | Entspricht ‘Erstellen’. Das Format für den Hauptteil ist obligatorisch. |
| DELETE | entspricht ‘delete’. |
| STELLEN | Entspricht ‘Aktualisieren/Ersetzen’. Das Format für den Hauptteil ist obligatorisch. |
| FLICKEN | Entspricht ‘Aktualisieren/Ändern’. Das Format für den Hauptteil ist obligatorisch. |
| OPTION | Gibt Informationen über die API (Methoden/Inhaltstyp) zurück. |
| HEAD | Gibt Informationen über die Ressource (Version/Länge/Typ) zurück. |
Format (nur für POST/PUT/PATCH) Das Format und der Content-Type des postBody, der an den REST-Endpunkt gesendet werden soll.
| Beschreibung des Formats | |
| JSON | postBody im JSON-Format. |
| EINFACH | postBody im Nur-Text-Format angegeben. Wenn dieses Format ausgewählt ist, wird eine Zeichenfolgen-JSON-Darstellung der Schlüssel-Wert-Liste an den REST-Endpunkt gesendet. |
| FORM | postBody im URL-codierten Format. |
| XML | postBody im XML-Format. |
Datentyp für Body (nur für POST/PUT/PATCH) Der Datentyp, in dem die Daten für den Text angegeben werden.
Konstanter Wert für Body (nur für POST/PUT/PATCH) Wenn diese Option aktiviert ist, wird der Wert für den Körper als Konstante gesetzt, wobei der Wert im Eingabefeld angegeben ist.
Datentyp für die Ausgabe Der Datentyp für den Ausgabeparameter.
Pfad
Hier können Sie den in der Abfrage-URL angegebenen Pfad konfigurieren.
Die Pfadwerte werden hellblau angezeigt.
Abfrage-Parameter
Hier können Sie die Abfrageparameter in der URL konfigurieren.
Die Werte der Abfrageparameter sind grün dargestellt.
Weitere Informationen zu Abfrageparametern finden Sie hier: https://community.simplifier.io/doc/current-release/integrate/connectors/rest-connector/rest-connector-call-query-parameters/
Kopfball
Hier können Sie die Header für Ihren REST-Aufruf konfigurieren.
Erfahren Sie hier mehr über REST-Header und mögliche Header-Typen: https://community.simplifier.io/doc/current-release/integrate/connectors/rest-connector/rest-connector-call-header-parameters/
Ergebnis der Ausführung des Connector-Aufrufs
Wenn der Connector-Aufruf ausgeführt wird, wird nur dann ein JSON-Code zurückgegeben, wenn der Inhaltstyp des HTTP-Ergebnisses “application/json” ist.
In allen anderen Fällen gibt der Connector ein JSON-Objekt mit den folgenden Schlüsseln zurück:
- RESTBinaryResult – mit dem BASE64-codierten Ergebnistext
- RESTTextResult – wird nur zurückgegeben, wenn es als Text angezeigt werden kann
- Content-Type – MIME-Typ des Ergebniskörpers
Fortgeschritten
Setzen Sie den Schalter ‘Erweitert’ in der oberen rechten Ecke des Dialogs auf true, um weitere Konfigurationsoptionen für die Ein- und Ausgabeparameter anzuzeigen.
Sie können z. B. festlegen, ob die Parameter erforderlich oder optional sind oder ob sie einen konstanten Wert haben sollen.
Erweiterte Konfiguration
Um erweiterte Funktionen unseres REST-Konnektors zu nutzen, können Sie zusätzliche Konfigurationsparameter hinzufügen.
Stellen Sie sicher, dass Sie zur Ansicht “Erweitert” wechseln, um diese Funktionen hinzuzufügen.
Erweiterte Parameter
| Parameter | Beschreibung | Mögliche Werte | Vorschlagswert |
| Uri | Überschreibt den konfigurierten Endpunkt-Basis-URI des Connectors für die aktive Instanz. Verwenden Sie diese Option NUR in Fällen, in denen Sie den Endpunkt-URI dynamisch festlegen müssen! |
Alle uris | – |
Ausführlichkeit und andere
| Parameter | Beschreibung | Mögliche Werte | Vorschlagswert |
| configuration/http/verbosity/ |
Definiert die Ausführlichkeit der empfangenen Http-Header | Quiet Es werden keine Informationen zurückgegebenNormal Die minimal erforderliche Menge an Informationen wird ausführlich zurückgegeben Die Informationen werden auf nicht-kompakte Weise dargestellt und es werden weitere Informationen zurückgegebenSehr-ausführlich Es werden noch mehr Informationen zurückgegebenDebuggen Alle möglichen Informationen werden zurückgegeben | Leise |
| configuration/http/verbosity/ |
Definiert die Ausführlichkeit des empfangenen Content-Type. | Leise Es werden keine Informationen zurückgegebenNormal: Die minimal erforderliche Menge an Informationen wird zurückgegebenAusführlich Die Informationen werden nicht kompakt dargestellt und es werden mehr Informationen zurückgegebenSehr-Ausführlich Es werden noch mehr Informationen zurückgegebenDebuggen Alle möglichen Informationen werden zurückgegeben | Leise |
| configuration/http/verbosity/ |
Definiert die Ausführlichkeit des empfangenen Statuscodes | Quiet Es werden keine Informationen zurückgegebenNormal Die minimal erforderliche Menge an Informationen wird zurückgegebenAusführlich Die Informationen werden auf nicht kompakte Weise dargestellt und es werden weitere Informationen zurückgegebenSehr-Ausführlich Noch mehr Informationen werden zurückgegebenDebuggen Alle möglichen Informationen werden zurückgegeben | Leise |
| configuration/http/charsets/sourceCharset | Definiert den Zeichensatz, den die Antwort codiert, wenn die Antwort keinen Zeichensatz im content-type-Header enthält | Jeder gültige Zeichensatz, wie UTF-8, ISO-8859-1 | UTF-8 für textbasierte Inhaltstypen ISO-8859-1 für Multimedia-Inhaltstypen |
| configuration/http/body/removeLinebreaks | Entfernt Zeilenumbrüche nach 76 Zeichen aus der Antwort (Standard in Bezug auf RFC 2045) | true / false | false |
Darstellung des Körpers
| Parameter | Beschreibung | Mögliche Werte | Vorschlagswert |
| configuration/http/body/ |
Definiert, wie das binäre Ergebnis zurückgegeben werden soll. Der Standardwert ist Base64 |
Basis 64 Das binäre Ergebnis wird als Base64 mit Zeilenumbrüchen gemäß RFC-2045 zurückgegeben Gezeichnet Das binäre Ergebnis wird in einem Array zurückgegeben, das aus ganzen Zahlen von -127 bis 127 besteht Signed-String Das binäre Ergebnis wird in einer Zeichenkette zurückgegeben, die aus ganzen Zahlen von -127 bis 127 besteht Ungekennzeichnet Das binäre Ergebnis wird in einem Array zurückgegeben, das aus ganzen Zahlen von 0 bis 255 besteht Zeichenfolge ohne Vorzeichen Das binäre Ergebnis wird in einer Zeichenkette zurückgegeben, die aus Ganzzahlen von 0 bis 255 besteht Fluch Das binäre Ergebnis wird in einem Array zurückgegeben, das aus Zeichenketten mit Paaren von Hexadezimalzeichen (0-9, A-F) besteht Hex-Saite Das binäre Ergebnis wird in einer Zeichenkette zurückgegeben, die aus Zeichenfolgen mit Paaren von Hexadezimalzeichen (0-9, A-F) besteht Data-URI – Das binäre Ergebnis wird in einer Data-URI zurückgegeben, z.B. “data:image/png;base64,[BASE-“ |
Basis 64 |
