Stellen Sie mit OpenAPI eine Verbindung zu Diensten her

1. Gehen Sie zu dem Dienst, den Sie mit App Studio verbinden möchten, und suchen Sie nach einer OpenAPI-Spezifikations-JSON-Datei.

   Anmerkung

   App Studio unterstützt OpenAPI-Spezifikationsdateien, die der Version OpenAPI-Spezifikation Version 3.0.0 oder höher entsprechen.

2. Sammeln Sie die notwendigen Daten, um den OpenAPI-Connector zu konfigurieren, einschließlich der folgenden:

   • Die Basis-URL für die Verbindung mit dem Dienst.

   • Anmeldeinformationen für die Authentifizierung, z. B. ein Token oder username/password.

   • Falls zutreffend, alle Header.

   • Falls zutreffend, alle Abfrageparameter.

Um einen Connector für OpenAPI zu erstellen

1. Navigieren Sie zu App Studio.

2. Wählen Sie im linken Navigationsbereich im Abschnitt Verwalten die Option Connectors aus. Sie werden zu einer Seite weitergeleitet, auf der eine Liste der vorhandenen Konnektoren mit einigen Details zu den einzelnen Konnektoren angezeigt wird.

3. Wählen Sie + Connector erstellen.

4. Wählen Sie OpenAPI Connector aus der Liste der Connectortypen aus. Konfigurieren Sie nun Ihren Connector, indem Sie die folgenden Felder ausfüllen.

5. Name: Geben Sie einen Namen für Ihren OpenAPI-Connector ein.

6. Beschreibung: Geben Sie eine Beschreibung für Ihren OpenAPI-Connector ein.

7. Basis-URL: Geben Sie die Basis-URL für die Verbindung zum Dienst ein.

8. Authentifizierungsmethode: Wählen Sie die Methode für die Authentifizierung beim Zieldienst.

   • Keine: Greifen Sie ohne Authentifizierung auf den Zieldienst zu.

   • Einfach: Greifen Sie mit einem Benutzernamen und einem Passwort auf den Zieldienst zu, mit dem eine Verbindung hergestellt wird.

   • Bearer-Token: Greifen Sie mithilfe des Token-Werts eines Authentifizierungstokens auf den Zieldienst zu, der über das Benutzerkonto oder die API-Einstellungen des Dienstes abgerufen wurde.

   • OAuth 2.0: Greifen Sie mit dem OAuth 2.0-Protokoll auf den Zieldienst zu, das App Studio Zugriff auf den Dienst und die Ressourcen gewährt, ohne Anmeldeinformationen oder Identitäten weiterzugeben. Um die OAuth 2.0-Authentifizierungsmethode zu verwenden, müssen Sie zunächst eine Anwendung aus dem Dienst erstellen, mit dem eine Verbindung hergestellt wird und die App Studio repräsentiert, um die erforderlichen Informationen zu erhalten. Füllen Sie mit diesen Informationen die folgenden Felder aus:

     1. Ablauf der Kundenanmeldedaten:

        1. Geben Sie im Feld Client-ID die ID des Zieldienstes ein.

        2. Geben Sie im Feld Client Secret den Schlüssel des Zieldienstes ein.

        3. Geben Sie im Feld Zugriffstoken-URL die Token-URL des Zieldienstes ein.

        4. Geben Sie optional im Feld Bereiche die Bereiche für die Anwendung ein. Bereiche sind Berechtigungen oder Zugriffsebenen, die für die Anwendung erforderlich sind. Lesen Sie in der API-Dokumentation des Zieldienstes nach, um deren Bereiche zu verstehen, und konfigurieren Sie nur die Bereiche, die Ihre App Studio-App benötigt.

        Fügen Sie bei jedem Aufruf alle Variablen hinzu, die mit dem Dienst gesendet werden sollen, und wählen Sie Verbindung verifizieren, um die Authentifizierung und Verbindung zu testen.

     2. Ablauf des Autorisierungscodes:

        1. Geben Sie im Feld Client-ID die ID des Zieldienstes ein.

        2. Geben Sie im Feld Client Secret den Schlüssel des Zieldienstes ein.

        3. Geben Sie im Feld Autorisierungs-URL die Autorisierungs-URL des Zieldienstes ein.

        4. Geben Sie im Feld Zugriffstoken-URL die Token-URL des Zieldienstes ein.

        5. Geben Sie optional im Feld Bereiche die Bereiche für die Anwendung ein. Bereiche sind Berechtigungen oder Zugriffsebenen, die für die Anwendung erforderlich sind. Lesen Sie in der API-Dokumentation des Zieldienstes nach, um deren Bereiche zu verstehen, und konfigurieren Sie nur die Bereiche, die Ihre App Studio-App benötigt.

9. Variablen: Fügen Sie Variablen hinzu, die bei jedem Aufruf an den Dienst gesendet werden sollen. Variablen, die während der Konfiguration hinzugefügt werden, werden sicher gespeichert und nur während der Laufzeit von Anwendungen abgerufen, die die Verbindung verwenden.

10. Header: Fügen Sie HTTP-Header hinzu, die verwendet werden, um Metadaten zur Anfrage oder Antwort bereitzustellen. Sie können sowohl Schlüssel als auch Werte hinzufügen oder nur einen Schlüssel angeben, für den der Builder einen Wert in der Anwendung bereitstellen kann.

11. Abfrageparameter: Fügen Sie Abfrageparameter hinzu, die verwendet werden, um Optionen, Filter oder Daten als Teil der Anforderungs-URL zu übergeben. Wie bei Headern können Sie sowohl einen Schlüssel als auch einen Wert angeben oder nur einen Schlüssel angeben, für den der Builder in der Anwendung einen Wert bereitstellen kann.

12. OpenAPI-Spezifikationsdatei: Laden Sie eine OpenAPI-Spezifikations-JSON-Datei hoch, indem Sie sie ziehen und ablegen, oder wählen Sie Datei auswählen, um in Ihrem lokalen Dateisystem zu navigieren, und wählen Sie die hochzuladende Datei aus.

    Nach dem Hinzufügen wird die Datei verarbeitet und eine Liste der verfügbaren Optionen wird angezeigt. Wählen Sie die erforderlichen Operationen für Ihren Connector aus.

13. Wählen Sie Erstellen aus. Der neu erstellte Connector wird in der Connectors-Liste angezeigt.