Connector Call-Assistent
Der Simplifier REST-Konnektor-Aufruf-Assistent bietet die automatische Generierung von Aufrufen über die OpenAPI 3 Spezifikation.
OpenAPI URL abrufen
Du kannst OpenAPI-Marktplätze wie
- SwaggerHub (https://app.swaggerhub.com/search)
- API Guru (https://apis.guru/)
Connector Calls über den Assistenten erstellen
Im folgenden Video findest du eine Schritt-für-Schritt-Anleitung
In der Connector Call-Übersicht findest du den Connector-Assistenten oben rechts.
Schritt 1: OpenAPI URL festlegen
Lege die OpenAPI URL fest, die der Assistent parsen soll, um die Connector Calls zu erstellen.
Schritt 2: Aufrufe auswählen
Als Nächstes kannst du auswählen, welche Aufrufe erstellt werden sollen. Verschiebe deine ausgewählten Aufrufe mit dem Pfeilsymbol in das rechte Feld. Klicke dann auf „Weiter“.
Schritt 3: Connector Calls bearbeiten
Nachdem du die gewünschten Aufrufe ausgewählt hast, kannst du deren Namen und Beschreibungen auf dem nächsten Bildschirm bearbeiten.
Wenn du die Aufrufe bearbeitet hast, klicke auf „Connector Calls erstellen“.
Standardkonfiguration
Dieser Abschnitt beschreibt die notwendigen Parameter und Datentypen für die manuelle Konfiguration von REST-Konnektor-Aufrufen.
Es gibt vier Tabs: „Allgemein“, „Pfad“, „Abfrageparameter“, „Header“.
Allgemein
Hier kannst du die grundlegenden Eigenschaften für deinen Connector Call konfigurieren.
Verb
| HTTP-Verb | Beschreibung |
| GET | Entspricht „Lesen“. |
| POST | Entspricht „Erstellen“. Das Format für den Body ist obligatorisch. |
| DELETE | Entspricht „Löschen“. |
| PUT | Entspricht „Aktualisieren/Ersetzen“. Das Format für den Body ist obligatorisch. |
| PATCH | Entspricht „Aktualisieren/Ändern“. Das Format für den Body ist obligatorisch. |
| OPTION | Gibt Informationen über die API zurück (Methoden/Content-Typ). |
| HEAD | Gibt Informationen über die Ressource zurück (Version/Länge/Typ). |
Format (nur für POST/PUT/PATCH)
Das Format und der Content-Type des postBody, der an den REST-Endpunkt gesendet werden soll.
| Format | Beschreibung |
| JSON | postBody im JSON-Format. |
| PLAIN | postBody im Klartextformat. Wenn dieses Format ausgewählt ist, wird eine String-JSON-Darstellung der Key/Value-Liste an den REST-Endpunkt gesendet. |
| FORM | postBody im URL-kodierten 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 Body angegeben werden.
Konstanter Wert für Body (nur für POST/PUT/PATCH)
Wenn aktiviert, wird der Wert für den Body als Konstante festgelegt, mit dem im Eingabefeld angegebenen Wert.
Datentyp für Ausgabe
Der Datentyp für den Ausgabeparameter.
Pfad
Hier kannst du den Pfad konfigurieren, der in der Abfrage-URL angegeben ist. Die Pfadwerte sind hellblau gekennzeichnet.
Abfrageparameter
Hier kannst du die Abfrageparameter in der URL konfigurieren. Die Werte der Abfrageparameter sind grün markiert. Erfahre hier mehr über Abfrageparameter: https://community.simplifier.io/doc/current-release/integrate/connectors/rest-connector/rest-connector-call-query-parameters/
Simplifier unterstützt auch mehrere gleiche Abfrageparameter. Wenn der Datentyp des Abfrageparameters auf eine Sammlung gesetzt ist, enthält die generierte REST-Abfrage jeden Sammlungswert als Abfrageparameter. Z.B. wird der Parameter param1 mit dem Sammlungswert [‘A’, ‘B’, ‘C’] zu param1=A¶m1=B¶m1=C.
Header
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/
Connector Call-Ausführungsergebnis
Wenn der Connector Call ausgeführt wird, wird nur dann ein JSON als Ergebnis zurückgegeben, wenn der Content-Typ 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-kodierten Ergebnis-Body
- RESTTextResult – wird nur zurückgegeben, wenn es als Text angezeigt werden kann
- Content-Type – MIME-Typ des Ergebnis-Bodys
Erweitert
Setze den Schalter „Erweitert“ oben rechts im Dialog auf „true“, um weitere Konfigurationsoptionen für die Eingabe- und Ausgabeparameter anzuzeigen.
Du kannst zum Beispiel definieren, ob die Parameter obligatorisch 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 erweiterten Ansicht wechseln, um diese Funktionen hinzuzufügen.
Erweiterte Parameter
| Parameter | Beschreibung | Mögliche Werte | Standardwert |
| uri | Überschreibt die konfigurierte Endpunkt-Basis-URI des Connectors für die aktive Instanz.
NUR verwenden, wenn die Endpunkt-URI dynamisch gesetzt werden muss! |
Alle URIs | – |
Ausführlichkeit und Sonstiges
| Parameter | Beschreibung | Mögliche Werte | Standardwert |
| configuration/http/verbosity/ |
Definiert die Ausführlichkeit der empfangenen HTTP-Header | Leise Es werden keine Informationen zurückgegebenNormal Die minimal erforderliche Informationsmenge wird zurückgegebenAusführlich Die Informationen werden nicht-kompakt dargestellt und es werden mehr Informationen zurückgegebenSehr ausführlich Noch mehr Informationen werden zurückgegebenDebug Alle möglichen Informationen werden zurückgegeben |
Leise |
| configuration/http/verbosity/ |
Definiert die Ausführlichkeit des empfangenen Content-Typs. | Leise Es werden keine Informationen zurückgegebenNormal Die minimal erforderliche Informationsmenge wird zurückgegebenAusführlich Die Informationen werden nicht-kompakt dargestellt und es werden mehr Informationen zurückgegebenSehr ausführlich Noch mehr Informationen werden zurückgegebenDebug Alle möglichen Informationen werden zurückgegeben |
Leise |
| configuration/http/verbosity/ |
Definiert die Ausführlichkeit des empfangenen Statuscodes | Leise Es werden keine Informationen zurückgegebenNormal Die minimal erforderliche Informationsmenge wird zurückgegebenAusführlich Die Informationen werden nicht-kompakt dargestellt und es werden mehr Informationen zurückgegebenSehr ausführlich Noch mehr Informationen werden zurückgegebenDebug Alle möglichen Informationen werden zurückgegeben |
Leise |
| configuration/http/charsets/sourceCharset | Definiert den Zeichensatz, in dem die Antwort kodiert ist, wenn die Antwort keinen Zeichensatz im Content-Type-Header enthält. Nur verwenden, wenn der Remote-Server eine bekannte Kodierung bereitstellt, aber keine korrekten Content-Type-Informationen mit seiner Antwort sendet. | Jeder gültige Zeichensatz, wie UTF-8, ISO-8859-1 | UTF-8 für textbasierte Content-Typen
ISO-8859-1 für Multimedia-Content-Typen |
| configuration/http/body/removeLinebreaks | Entfernt Zeilenumbrüche nach 76 Zeichen aus der Antwort (Standard gemäß RFC 2045) DIESE OPTION WURDE MIT MAKERS CHOICE 25-07 ENTFERNT |
true / false | false |
Body-Darstellung
| Parameter | Beschreibung | Mögliche Werte | Standardwert |
| configuration/http/body/ |
Definiert, wie das binäre Ergebnis zurückgegeben werden soll. Der Standard ist Base64 | Base64 Das binäre Ergebnis wird als Base64 mit Zeilenumbrüchen gemäß RFC-2045 zurückgegebenSigned Das binäre Ergebnis wird in einem Array zurückgegeben, das aus Ganzzahlen von -127 bis 127 bestehtSigned-String Das binäre Ergebnis wird in einem String zurückgegeben, der aus Ganzzahlen von -127 bis 127 bestehtUnsigned Das binäre Ergebnis wird in einem Array zurückgegeben, das aus Ganzzahlen von 0 bis 255 besteht Unsigned-String Das binäre Ergebnis wird in einem String zurückgegeben, der aus Ganzzahlen von 0 bis 255 bestehtHex Das binäre Ergebnis wird in einem Array zurückgegeben, das aus Strings von Paaren hexadezimaler Zeichen (0-9, A-F) bestehtHex-String Das binäre Ergebnis wird als String zurückgegeben, der aus Paaren von hexadezimalen Zeichen (0-9, A-F) besteht. Data-URI – Das binäre Ergebnis wird als Data-URI zurückgegeben, z. B. „data:image/png;base64,[BASE-„ |
Base64 |
