Erstellen Ihres Connectors aus einer API-Definition

Neuen Connector erstellen

1. If you select Start from an API definition, you must provide the API definition:

   • 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.

     

2. Wählen Sie die Schaltfläche zum Fortfahren aus.

Konfigurieren Ihres Connectors

1. In the Confirm import window, you can:

   • Ändern Sie den Anbieternamen, den Anwendungsnamen und den Connector-Namen.

   • Ändern Sie die Ressourcen, die Sie in Ihrem benutzerdefinierten Connector verwenden möchten. Alle verfügbaren Ressourcen werden automatisch aktiviert. Deaktivieren Sie diejenigen, die Sie ausschließen möchten.

     • Use the Search bar to look for a specific resource.

   • Wählen Sie Erstellen.

     

2. The Settings window is now displayed.

3. In the Info tab you can configure the following fields:

   • Name – Dies spiegelt sich in Ihrem Connectorschlüssel wider.
   • API type – This field is disabled by default, as only REST is currently supported.
   • Kategorien – Sie können aus den verfügbaren Kategorien auswählen, z. B. Künstliche Intelligenz oder Marketing, oder Ihre eigene Kategorie erstellen.
   • Description – Enter a description for your connector.
   • Symbol – Wählen Sie Durchsuchen aus, um ein Bild von Ihrem Computer hochzuladen. Alle Bildtypen werden unterstützt, aber wir empfehlen die Verwendung einer quadratischen SVG-Datei.

4. Catalog preview displays how your custom connector will appear in the Integration Service connector catalog.

5. Wählen Sie Speichern.

   

Basis-API konfigurieren

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

• Base URL – Automatically filled with the value declared at connector creation.

• Paginierungstyp – Die in der Dropdownliste verfügbaren Optionen sind: Seitenbeginn mit 1, Seite beginnt mit 0, Offset, Benutzerdefiniert, Keine. Wenn die Anbieterdokumentation keine Details zur Paginierung enthält, behalten Sie den Standardwert bei. Weitere Informationen dazu finden Sie im Abschnitt Paginierung .

• Pagination max – Default value is 100. If the vendor documentation doesn’t provide any details on pagination, keep the default value.

• Content-Type Header – Dieses Feld ist standardmäßig deaktiviert. Derzeit wird nur application/json unterstützt.

• Header akzeptieren – Dieses Feld ist standardmäßig deaktiviert. Derzeit wird nur application/json unterstützt.

  

Paginierung (Pagination)

Die Paginierung ermöglicht es Anbieteranwendungen, Teile einer Antwort inkrementell statt alle gleichzeitig zurückzugeben, wodurch die Reaktionszeit optimiert wird.

Die Paginierung kann auf verschiedene Arten implementiert werden. UiPath-Connectors verwenden eine standardisierte Paginierungskonfiguration, um sicherzustellen, dass alle Connectors auf die gleiche Weise funktionieren.

Sie können Paginierungseinstellungen auf Connector-Ebene in Einstellungen > Basis-API konfigurieren, indem Sie die Felder Paginierungstyp und Paginierung max. definieren. Bei Listenbasierten Aktivitäten können Sie die Paginierung auf Ressourcenebene weiter konfigurieren.

Paginierungstypen

Das Feld Paginierungstyp bietet mehrere Optionen, um es an verschiedene Spezifikationen des Anbieters anzupassen:

• Seite beginnt mit 1
• Seiten beginnen mit 0
• Offset
• Cursor
• Keine

Die Aktivitäten des benutzerdefinierten Connectors funktionieren in Ihrer Studio-Umgebung unabhängig vom ausgewählten Paginierungstyp. Um sicherzustellen, dass Sie vollständige Antworten erhalten, ist es jedoch wichtig, dass Sie den richtigen Paginierungstyp angeben und konfigurieren.

Die Seite beginnt mit 1 und die Seite beginnt mit 0

Seitenbasierte Paginierungstypen basieren auf Abfrageparametern, die an den Anbieter übergeben werden, um anzugeben, welche Seite der Ergebnisse zurückgegeben werden soll und wie viele Ergebnisse pro Seite angezeigt werden sollen.

Beispielsweise verwendet GitHub eine seitenbasierte Paginierung, wie unter Verwenden der Paginierung in der REST-API erläutert. Sie haben die URL der nächsten Seite in den Antwortheader aufgenommen, um die Implementierung zu erleichtern. Der zugrunde liegende Mechanismus basiert jedoch auf den Abfrageparametern Seite und pro\_Seite .

Im Connector Builder können Sie eine der folgenden Optionen auswählen:

• Seite beginnt mit 1 bezieht sich auf eine Paginierung, bei der die erste Seite der Ergebnisse den Index eins hat (z. B. page=1).
• Seite beginnt mit 0 bezieht sich auf eine Paginierung, bei der sich die erste Seite der Ergebnisse beim Index von Null befindet (z. B. Seite=0).

Ressourcenkonfiguration

Standardmäßig weist die seitenbasierte Paginierung Page und pageSize als Paginierungsparameter zu. Sie können diese wie folgt zu Anbieterspezifikationen überschreiben:

1. Wählen Sie Ihre Ressource aus.
2. Wählen Sie die Registerkarte Paginierung aus.
3. Aktivieren Sie die Paginierung, und aktualisieren Sie die Parameternamen, damit sie mit den Parametern des Anbieters übereinstimmen.

Cursor-Paginierung

Die Cursor-basierte Paginierung basiert auf einem Seitentoken, das vom Anbieter zurückgegeben wird, anstelle einer Seiten- oder Offsetnummer, die an nachfolgende Aufrufe übergeben werden kann, um die nächste Seite mit Ergebnissen zurückzugeben.

Wenn Sie im Connector Builder eine Anforderung für einen Connector stellen, der Cursor-basierte Paginierung verwendet, werden die zurückgegebenen Ergebnisse nicht automatisch paginiert. Daher werden nicht alle Ergebnisse zurückgegeben, ohne den nächsten Cursor manuell in einen nachfolgenden Aufruf einzuschließen.

Ähnlich wie andere Paginierungstypen enthält die Cursor-basierte Paginierung in der Regel einen Wert zur Angabe der Anzahl der Ergebnisse pro Seite.

Ressourcenkonfiguration

Die Cursorbasierte Paginierung bietet Standardnamen für den Cursor und die Seitengröße (nextPage und pageSize, die Sie überschreiben können, um den Spezifikationen des Anbieters zu entsprechen.

Identifizieren des Seitentokenpfads

Der Cursor für die nächste Seite wird häufig in den API-Antwortfeldern eingebettet. Daher ist es wichtig, die Position des Cursors im Antwortschema anzugeben, damit der Integration Service den Seitentokenwert extrahieren und in einer nachfolgenden Antwort verwenden kann.

Sie können den Ort im Antwortfeld wie folgt angeben:

1. Geben Sie an, wo sie sich in der Antwort befindet (Text oder Header).
2. Identifizieren Sie den Feldpfad mit Punkten, die jede Ebene trennen.

Wenn der Cursor in einer URL verschachtelt ist, können Sie ein Fragezeichensymbol (?) verwenden, um den abzurufenden Abfrageparameter darzustellen.

Beispiel

Die Meta Graph-API bietet ein gutes Beispiel für die Verwendung von Cursor-basierte Paginierung im Connector Builder. Die Meta-Paginierungs-Dokumentation gibt an, wo sich in jeder Anforderung das Token für die nächste Seite befindet, und enthält einen direkten Verweis auf das Token oder die vollständige URL. Anhand dieser Beispiele können wir eine Ressourcenpaginierung für die Meta Graph-API erstellen.

1. Aktualisieren Sie in der ausgewählten Ressource den NextPage -Tokennamen und den pageSize- Namen so, dass sie mit der Anbieter-API übereinstimmen. Laut der Meta Graph-API-Dokumentation ist der NextPage -Tokenname nach und pageSize ist Limit.

2. Ermitteln Sie als Nächstes, wo das NextPage -Token für jede Anforderung verfügbar ist. Die Dokumentation stellt dieses JSON-Objekt bereit, das die Speicherorte zuordnet:

   {  "data": [     ... Endpoint data is here  ],  "paging": {    "cursors": {      "after": "MTAxNTExOTQ1MjAwNzI5NDE=",      "before": "NDMyNzQyODI3OTQw"    },    "previous": "https://graph.facebook.com/{your-user-id}/albums?limit=25&before=NDMyNzQyODI3OTQw",    "next": "https://graph.facebook.com/{your-user-id}/albums?limit=25&after=MTAxNTExOTQ1MjAwNzI5NDE="  }}

Dies ist Teil des Antworttexts, sodass Sie das NextPage -Token auf zwei Arten konfigurieren können:

1. Direkte Zuordnung zum Seitentoken (bevorzugt): body.paging.cursors.after.
2. Verwenden Sie die nächste URL: body.paging.next?after.

Beide Pfade stellen dem Connector den richtigen Speicherort zum Abrufen des Werts des nextPage -Tokens bereit.

Versatz der Paginierung

Die Offset-Paginierung verwendet Datensatznummern, um die Paginierung durch alle Antwortobjekte zu ermöglichen. Der Parameter Offset gibt die Anzahl der Elemente an, die übersprungen werden sollen, bevor Ergebnisse zurückgegeben werden.

Bei der Offset-Paginierung werden häufig die folgenden beiden Parameter verwendet (die genauen Namen können variieren)

• Offset – Gibt den Datensatz an, an dem mit der Rückgabe der Ergebnisse begonnen werden soll.
• Limit – gibt die Anzahl der Ergebnisse pro Seite an.

Ressourcenkonfiguration

Standardmäßig weist die seitenbasierte Paginierung Page und pageSize als Paginierungsparameter zu. Sie können diese wie folgt zu Anbieterspezifikationen überschreiben:

1. Wählen Sie Ihre Ressource aus.
2. Wählen Sie die Registerkarte Paginierung aus.
3. Aktivieren Sie die Paginierung, und aktualisieren Sie die Parameternamen, damit sie mit den Parametern des Anbieters übereinstimmen.

Paginierungstyp Keiner

Wenn die Anbieter-API keine Paginierung verwendet, legen Sie den Paginierungstyp auf Keine fest.

Ressourcenkonfiguration

Wenn Sie den Paginierungstyp auf Keine festlegen, wird die Registerkarte Paginierung aus den Aktivitätsressourcen der Liste entfernt.

Paginierung max.

Das Feld Paginierung max bezieht sich auf die maximale Anzahl von Ergebnissen, die der Anbieter zurückgeben kann.

Integration Service hat einen oberen Schwellenwert von 2.000 Ergebnissen. Um die Effizienz zu verbessern, empfehlen wir die Verwendung einer niedrigeren Zahl.

Authentifizierungsmethode festlegen

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

Testen Sie Ihre Verbindung

Once you have completed the authentication configuration, select Add connection from the drop-down menu:

If your connection is successful, the status is updated to Connected.

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.

1. Wählen Sie Weitere Optionen aus Schaltflächenmenü, um jede Methode weiter zu konfigurieren. Sie können:

   • Add method – Opens the Create new resource window.

   • Allow method deletion – Activates a Delete icon for each resource in the group.

   • Edit path – Edit the resource’s path. For example: [BASE URL]/pet = https://petstore.swagger.io/v2/pet

   • Delete – Deletes a resource group. A message warns you that the operation cannot be undone.

   • Duplizieren – Öffnet das Fenster Ressource duplizieren , in dem Sie den Pfad bearbeiten, einen Anzeigenamen auswählen und Methoden auswählen können.

     

2. Sie können auch auf zwei Arten neue Ressourcengruppen erstellen :
   • Leer: Konfigurieren Sie die folgenden Felder:

     • Path - [Base URL]/[path]

     • Anzeigename

     • Select methods: Get, Get By Id, Post, Put, Patch, Delete

       

   • Über cURL: Geben Sie einen cURL-Befehl ein.

Konfigurieren Sie Ihre Ressourcen

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

Depending on the resource method you select, the following configuration tabs are available: Parameters, Response/Request Fields, Pagination, Search.

Parameter

Beispielsweise sind alle vier Registerkarten für GET-Methoden verfügbar. Bei POST-Methoden werden nur die Registerkarten Parameter, Anforderungsfelder und Antwortfelder angezeigt.

In Parameter können Sie die Liste der 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.

The Pet object corresponds to the Pet resource group, and the available fields are the ones set for the GETBYID resource:

Antwort- und Anforderungsfelder

Hinweis:

Verschachtelte Array-Objekte werden derzeit nicht unterstützt.

The Response and Request fields for each resource are automatically generated upon sending a request.

Auf jeder entsprechenden Registerkarte können Sie jedes Feld bearbeiten oder löschen. Wenn Sie das Symbol Bearbeiten auswählen, wird das folgende Konfigurationsfenster angezeigt:

In the Response/Request fields tab, the following options are also available:

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

• Additional options button:

  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.

• Add row button - Adds new fields to the resource.

Wählen Sie das Symbol Sichtbare Spalten aus, um Spalten in der Feldtabelle hinzuzufügen oder zu löschen.

Each color under the Methods column corresponds to a certain method: Get, Get by ID, Post, Put, Patch, Delete.

Paginierung (Pagination)

Enable Pagination for a resource if you expect a list response. If you enable pagination, you also need to define the Response root key in the configuration tab, for nested lists.

Suche

Activate the Enable Search checkbox to allow search setup for a resource.

Nachdem Sie alles konfiguriert haben, was Sie benötigen, können Sie mit fortfahren.