Erstellen Ihres Connectors aus einer API-Definition

Neuen Connector erstellen

Wenn Sie Mit einer API-Definition beginnen auswählen, müssen Sie die API-Definition angeben:
- Aus einer lokalen Datei: Laden Sie eine Postman- oder Swagger-Sammlung hoch.
- Aus einer URL – Geben Sie eine Datei-URL ein, z. B. https://petstore.swagger.io/v2/swagger.json.
Klicken Sie auf Fortfahren.

Konfigurieren Ihres Connectors

Im Fenster Import bestätigen können Sie:
- Ändern Sie den Anbieternamen, den Anwendungsnamen und den Connectornamen.
- Ändern Sie die Ressourcen, die Sie in Ihrem benutzerdefinierten Connector verwenden möchten. Alle verfügbaren Ressourcen werden automatisch ausgewählt. Deaktivieren Sie diejenigen, die Sie ausschließen möchten.
  - Verwenden Sie die Suchleiste, um nach einer bestimmten Ressource zu suchen.
- Klicken Sie auf Erstellen.
Nun wird das Fenster Einstellungen angezeigt.
Auf der Registerkarte Über können Sie die folgenden Felder konfigurieren:
- Connector-Präfix: Beispiel: documentation. Dies spiegelt sich in Ihrem Connectorschlüssel wider.
- Anbietername: Geben Sie einen Anbieternamen ein.
- Anwendungsname: Geben Sie einen Anwendungsnamen ein.
- API-Typ: Dieses Feld ist standardmäßig deaktiviert, da derzeit nur REST unterstützt wird.
- Anzeigename – Dies ist der Name Ihres Connectors, wie er im Connector-Katalog angezeigt wird.
- Beschreibung: Geben Sie eine Beschreibung für Ihren Connector ein.
- Symbol – Klicken Sie auf Durchsuchen , um ein Bild von Ihrem Computer hochzuladen.
In der Katalogvorschau sehen Sie, wie Ihr benutzerdefinierter Connector im Integration Service-Connector-Katalog angezeigt wird.
Klicken Sie auf Speichern.

Basis-API konfigurieren

Auf der Registerkarte Basis-API konfigurieren Sie die Basis-URL für die Anwendungs-API und die Paginierung:

Basis-URL – Wird automatisch mit dem Wert ausgefüllt, der bei der Connector-Erstellung deklariert wurde.
Paginierungstyp – In der Dropdownliste verfügbare Optionen sind: Seite beginnt mit 1, Seite beginnt mit 0, Versatz, Benutzerdefiniert. Wenn die Dokumentation des Anbieters keine Details zur Paginierung enthält, behalten Sie den Standardwert bei.
Paginierung max . – Der Standardwert ist 100. Wenn die Dokumentation des Anbieters keine Details zur Paginierung enthält, behalten Sie den Standardwert bei.
Content-Type-Header – Dieses Feld ist standardmäßig deaktiviert, da derzeit nur application/json unterstützt wird.
Header akzeptieren – Dieses Feld ist standardmäßig deaktiviert, da derzeit nur application/json unterstützt wird.

Authentifizierungsmethode festlegen

Auf der Registerkarte Authentifizierung konfigurieren Sie den Authentifizierungstyp für Ihren Connector. Weitere Informationen zu den unterstützten Optionen finden Sie unter Authentifizierungstypen.

Testen Sie Ihre Verbindung

Nachdem Sie die Authentifizierungskonfiguration abgeschlossen haben, wählen Sie Verbindung hinzufügen aus dem Dropdownmenü aus:

Wenn Ihre Verbindung erfolgreich ist, wird der Status zu Verbunden aktualisiert.

Ressourcen

Der Connector-Generator generiert die Liste der Ressourcen basierend auf der bereitgestellten API-Definition. Im Menü auf der linken Seite wird die Liste der verfügbaren Ressourcen angezeigt, die in Gruppen angeordnet sind.

Klicken Sie auf Weitere Optionen Schaltflächenmenü, um jede Methode weiter zu konfigurieren. Sie können:
- Methode hinzufügen – Öffnet das Fenster Neue Ressource erstellen .
- Löschen von Methoden zulassen – Aktiviert ein Löschen -Symbol für jede Ressource in der Gruppe.
- Pfad bearbeiten – Bearbeiten Sie den Pfad der Ressource. Beispiel: [BASE URL]/pet = https://petstore.swagger.io/v2/pet
- Löschen – Löscht eine Ressourcengruppe. Eine Warnmeldung weist darauf hin, dass der Vorgang nicht rückgängig gemacht werden kann.
- Duplizieren – Öffnet das Fenster Ressource duplizieren , in dem Sie den Pfad bearbeiten, einen Anzeigenamen auswählen und Methoden auswählen können.
Sie können auch auf zwei Arten eine neue Ressourcengruppe erstellen :
- von leer
- von cURL
Wenn Sie eine neue Ressource von Leer konfigurieren möchten, konfigurieren Sie die folgenden Felder:
- Pfad – [Base URL]/[path]
- Anzeigename
- Methoden auswählen: Get, Get By Id, Post, Put, Patch, Delete
Wenn Sie eine neue Ressource über cURL konfigurieren möchten, geben Sie einen cURL-Befehl ein.

Konfigurieren Sie Ihre Ressourcen

Wenn Sie eine Ressource auswählen, wird das folgende Fenster angezeigt:

Je nach der von Ihnen ausgewählten Ressourcenmethode sind die folgenden Konfigurationsregisterkarten verfügbar: Parameters, Response/Request Fields, Pagination, Search.

Parameter

Beispielsweise sind alle vier Registerkarten für GET-Methoden verfügbar. Bei POST-Methoden können Sie nur die Registerkarten Parameter, Anforderungsfelder und Antwortfelder sehen.

Unter Parameter können Sie die auf der Liste verfügbaren Parameter für die ausgewählte Ressource anzeigen, neue Parameter hinzufügen oder Parameter aus einer vorhandenen Ressource importieren.

Die in dieser Tabelle aufgeführten Parameter sind diejenigen, die Sie in Studio beim Erstellen von Automatisierungen mit Ihrem benutzerdefinierten Connector verwenden.

Das Objekt Pet entspricht der Ressourcengruppe Pet. Die verfügbaren Felder sind diejenigen, die für die Ressource GETBYID festgelegt wurden:

Antwort- und Anforderungsfelder

Die Felder Antwort und Anforderung für jede Ressource werden beim Senden einer Anforderung automatisch generiert.

Auf den jeweiligen Registerkarten können Sie jedes Feld bearbeiten oder löschen. Wenn Sie auf das Symbol Bearbeiten klicken, wird das folgende Konfigurationsfenster angezeigt:

Auf der Registerkarte Antwort-/Anforderungsfelder sind auch die folgenden Optionen verfügbar:

Kontrollkästchen Bei Sendeanforderung überschreiben – Wenn diese Option ausgewählt ist, wird die Feldliste neu generiert, wenn Sie eine Sendeanforderung ausführen. Wählen Sie diese Option nicht aus, wenn Sie Ihrer Ressource neue Felder hinzugefügt haben.

Schaltfläche „Zusätzliche Optionen “:

Option	Was es tut
Stammschlüssel der Antwort aktualisieren	Definieren Sie den Antwortschlüssel, wenn Sie in der Antwort geschachtelte Arrays verwenden.
Alle Felder für Methode löschen	Löscht alle Felder für die ausgewählte Methode.
Aus Nutzlast generieren	Verwenden Sie eine Beispielnutzlast aus der Dienstdokumentation oder einen API-Aufruf, um die Ressourcenfelder zu generieren.

Schaltfläche „ Zeile hinzufügen“ – Fügt der Ressource neue Felder hinzu.

Klicken Sie auf das Symbol Sichtbare Spalten , um Spalten in der Feldtabelle hinzuzufügen oder zu löschen.

Jede Farbe in der Spalte „ Methoden “ entspricht einer bestimmten Methode: Get, Get by ID, Post, Put, Patch, Delete.

Paginierung (Pagination)

Aktivieren Sie die Paginierung für eine Ressource, wenn Sie eine Listenantwort erwarten. Wenn Sie die Paginierung aktivieren, müssen Sie auch den Antwortstammschlüssel auf der Registerkarte „Konfiguration“ für geschachtelte Listen definieren.