Erstellen Ihres Connectors aus einer API-Definition

Neuen Connector erstellen

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

     

     
     
2. Klicken Sie auf Fortfahren.

Konfigurieren Ihres Connectors

1. 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 aktiviert. Deaktivieren Sie diejenigen, die Sie ausschließen möchten.

     • Verwenden Sie die Suchleiste, um nach einer bestimmten Ressource zu suchen.

   • Klicken Sie auf Erstellen.
     
     

     

     
     
2. Nun wird das Fenster Einstellungen angezeigt.

3. Auf der Registerkarte Über können Sie die folgenden Felder konfigurieren:

   • Name – Dies spiegelt sich in Ihrem Connectorschlüssel wider.
   • API-Typ: Dieses Feld ist standardmäßig deaktiviert, da derzeit nur REST unterstützt wird.
   • Kategorien – Sie können aus den verfügbaren Kategorien auswählen, z. B. Künstliche Intelligenz oder Marketing, oder Ihre eigene erstellen.
   • Beschreibung: Geben Sie eine Beschreibung für Ihren Connector ein.
   • Symbol : Klicken Sie auf Durchsuchen , um ein Bild von Ihrem Computer hochzuladen. Alle Bildtypen werden unterstützt, aber wir empfehlen die Verwendung einer quadratischen SVG-Datei.
4. In der Katalogvorschau sehen Sie, wie Ihr benutzerdefinierter Connector im Integration Service-Connector-Katalog angezeigt wird.
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:

• Basis-URL – Wird automatisch mit dem Wert ausgefüllt, der bei der Connector-Erstellung deklariert wurde.
• Paginierungstyp – Die in der Dropdownliste verfügbaren Optionen sind: Seitenanfang bei 1, Seite beginnt bei 0, Offset, Benutzerdefiniert, Keine. Wenn die Anbieterdokumentation keine Details zur Paginierung enthält, behalten Sie den Standardwert bei. Weitere Informationen finden Sie im Abschnitt Paginierung .
• 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. 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 listbasierten Aktivitäten können Sie die Paginierung auf Ressourcenebene weiter konfigurieren.

Paginierungstypen

Das Feld Paginierungstyp bietet mehrere Optionen, um sie an verschiedene Anbieterspezifikationen 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 von Paginierung in der REST-API erläutert. Sie haben zur einfacheren Implementierung die URL der nächsten Seite in den Antwortheader aufgenommen, aber der zugrundeliegende Mechanismus basiert auf den Abfrageparametern Page und per_page .

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

• Seite beginnt mit 1 bezieht sich auf die Paginierung, bei der die erste Seite der Ergebnisse den Index 1 hat (z. B. Seite=1).
• Seite beginnt mit 0 bezieht sich auf 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 gegenüber 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 Cursor-basierte Paginierung bietet Standardnamen für den Cursor und die Seitengröße (NextPage und Seitengröße), die Sie entsprechend den Anbieterspezifikationen überschreiben können.

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-basierter Paginierung im Connector Builder. In der Dokumentation zur Meta-Paginierung wird angegeben, wo Sie in jeder Anforderung das Token für die nächste Seite finden, und sie enthält einen direkten Verweis auf das Token oder die vollständige URL. Wir können diese Beispiele verwenden, um die Ressourcen-Paginierung für die Meta Graph API zu erstellen.

1. Aktualisieren Sie auf der ausgewählten Ressource den Tokennamen nextPage und den pageSize- Namen so, dass sie mit der Anbieter-API übereinstimmen. Gemäß der Meta Graph API-Dokumentation ist der Tokenname nextPage after und pageSize limit.

2. Ermitteln Sie als Nächstes, wo das NextPage- Token bei jeder Anforderung verfügbar ist. Die Dokumentation stellt uns dieses JSON-Objekt zur Verfügung, 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="
     }
   }

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

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 eine 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, für den mit der Rückgabe der Ergebnisse begonnen werden soll.

• Grenzwert – 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 gegenüber 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 Paginierungstyp auf Keine fest.

Ressourcenkonfiguration

Wenn Sie Paginierungstyp auf Keine festlegen, wird die Registerkarte Paginierung aus den Aktivitätsressourcen List 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 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.

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

     

     
     

2. Sie können auch auf zwei Arten eine neue Ressourcengruppe erstellen :

   • Leer: Konfigurieren Sie die folgenden Felder:
     • Pfad – [Base URL]/[path]
     • Anzeigename
     • Methoden auswählen: Get, Get By Id, Post, Put, Patch, Delete
       
       

       

       
       
   • Von cURL: 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.

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.

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

Antwort- und Anforderungsfelder

Hinweis:

Verschachtelte Array-Objekte werden derzeit nicht unterstützt.

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 Anforderungssenden überschreiben – Wenn diese Option aktiviert 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.

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

Suche

Aktivieren Sie das Kontrollkästchen Enable Search , um die Sucheinrichtung für eine Ressource zuzulassen.

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