Zum Inhalt springen

REST-Datenquelle im Jitterbit App Builder

Einführung

Die REST-Datenquelle ermöglicht es Ihnen, den App Builder mit verschiedenen REST-Servern (einschließlich anderer Instanzen des App Builders) zu verbinden oder für die Verwendung mit REST-Objekten. Die Konfiguration eines REST-Datenquellenservers wird über alle REST-Endpunkte hinweg verwendet.

Die Einrichtung einer REST-Datenquelle umfasst die folgenden Schritte:

  1. Erstellen Sie einen REST-Datenquellenserver.

  2. Konfigurieren Sie die Anfrage-Header.

  3. Konfigurieren Sie die Abfragezeichenfolgenparameter.

  4. Erstellen Sie REST-Endpunkte für jede aufgerufene API-Methode.

  5. Fügen Sie REST-Endpunkte hinzu.

  6. (Optional) Überschreiben Sie die Inhaltstypen der Anfrage/Antwort-Endpunkte.

  7. (Optional) Konfigurieren Sie die Antwort-Paginierung.

Seit App Builder 4.45 können Sie auch einen REST-Endpunkt aus einem OpenAPI-Dokument erstellen.

Erstellen Sie einen REST-Datenserver

Um einen REST-Datenserver zu erstellen, befolgen Sie diese Schritte:

  1. Wählen Sie IDE > Datenserver.

  2. Klicken Sie auf die Schaltfläche + Server.

  3. Geben Sie im Abschnitt Servereinstellungen die folgenden Felder ein:

    • Servername: Geben Sie einen Namen für den REST-Server ein.

    • Typ: Öffnen Sie das Menü und wählen Sie REST API aus.

    • Url: Geben Sie die URL des Servers ein, mit dem Sie sich verbinden möchten.

      Hinweis

      Endpunkte werden im nächsten Abschnitt konfiguriert.

    • Inhaltstyp der Anfrage und Inhaltstyp der Antwort: Wählen Sie die Inhaltstypen für Anfrage und Antwort aus. (Typischerweise kommunizieren REST-Server über JSON.)

  4. (Optional) Erweitern Sie den Abschnitt Sicherheitseinstellungen und legen Sie die folgenden fest:

    • Sicherheitsanbieter: Öffnen Sie das Menü und wählen Sie den erforderlichen Sicherheitsanbieter aus.

    • Benutzername: Geben Sie den Benutzernamen für den Sicherheitsdienst an.

    • Passwort: Geben Sie das Passwort für den Sicherheitsdienst an.

    Tipp

    Die meisten REST-APIs verwenden einen API-Schlüssel im Header (der in einem späteren Abschnitt konfiguriert wird).

  5. (Optional) Beschreibung: Geben Sie eine Beschreibung für diesen Server ein.

  6. Klicken Sie auf die Speichern-Schaltfläche und schließen Sie den Dialog.

Sie sollten Ihren REST-Datenserver in der Liste der Datenserver sehen.

Anfrage-Header konfigurieren

Die meisten REST-Dienste erfordern, dass Sie einen API-Schlüssel über den Anfrage-Header übergeben.

Um den Anfrage-Header zu konfigurieren, befolgen Sie diese Schritte:

  1. Wählen Sie IDE > Datenserver.

  2. Klicken Sie auf die Details-Schaltfläche für Ihren neuen REST-Datenserver.

  3. Im Panel Webdienstparameter klicken Sie auf die Schaltfläche + Parameter. Eine neue Zeile erscheint im Panel. Setzen Sie die Werte wie folgt:

    • Typ: Öffnen Sie das Menü und wählen Sie Header.

    • Name: Geben Sie den Namen des Header-Parameters ein. (Für App Builder REST-Server wird der API-Schlüssel über "X-API-Key" übergeben.)

    • Wert: Geben Sie den Wert des Header-Parameters ein.

    • Verwendungstyp: Öffnen Sie das Menü und wählen Sie den Verwendungstyp für diesen Parameter.

  4. Klicken Sie auf das -Symbol, um den Parameter zu speichern.

Abfragezeichenfolgenparameter konfigurieren

Wenn Sie gängige Abfragezeichenfolgenparameter haben, die über Endpunkte hinweg verwendet werden sollen, können Sie diese mit den folgenden Schritten konfigurieren:

  1. Wählen Sie IDE > Datenserver.

  2. Klicken Sie auf die Details-Schaltfläche für Ihren neuen REST-Datenserver.

  3. Im Panel Webdienstparameter klicken Sie auf die Schaltfläche + Parameter. Eine neue Zeile erscheint im Panel. Setzen Sie die Werte in der Zeile wie folgt:

    • Typ: Abfrage

    • Name: Geben Sie den Namen des Abfragezeichenfolgenparameters ein.

    • Wert: Geben Sie den Wert des Abfragezeichenfolgenparameters ein.

    • Verwendungstyp: Öffnen Sie das Menü und wählen Sie den Verwendungstyp für diesen Parameter.

  4. Klicken Sie auf das -Symbol, um den Webserver-Parameter zu speichern.

REST-Endpunkte hinzufügen

Sobald Ihr REST-Datenserver konfiguriert ist, können Sie API-Endpunkte hinzufügen.

Um einen Endpunkt hinzuzufügen, befolgen Sie diese Schritte:

  1. Wählen Sie IDE > Datenserver.

  2. Klicken Sie auf die Details-Schaltfläche für Ihren neuen REST-Datenserver.

  3. Im Endpoints-Panel klicken Sie auf die Schaltfläche + Endpoint. Eine neue Zeile erscheint im Panel. Setzen Sie die Werte in der Zeile wie folgt:

    • Name: Geben Sie den Namen des Endpunkts ein.

    • Endpoint: Geben Sie den Endpunkt ein. (Dieser Wert wird an die in einem früheren Abschnitt festgelegte REST Data Server-URL angehängt.)

    • Method: Wählen Sie die HTTP-Methode für den Endpunkt aus.

  4. Klicken Sie auf das -Symbol, um den Endpunkt zu speichern.

Override endpoint request/response content types

Der Standardwert für die Inhaltstypen von Anfrage und Antwort wird vom Inhaltstyp des Servers übernommen. Die verfügbaren Werte für den Inhaltstyp sind wie folgt:

Um die Inhaltstypen der Anfrage oder Antwort des Endpunkts zu überschreiben, befolgen Sie diese Schritte:

  1. Wählen Sie im Endpoints-Panel Mehr > Edge Case. Der Dialog Endpoint Edge Case öffnet sich.

  2. Klicken Sie auf die Schaltfläche Bearbeiten.

  3. Im Abschnitt Inhaltstyp setzen Sie die Werte für Folgendes:

    • Anfrage: Öffnen Sie das Menü und wählen Sie den überschreibenden Anfrage-Inhaltstyp aus.

    • Antwort: Öffnen Sie das Menü und wählen Sie den überschreibenden Antwort-Inhaltstyp aus.

  4. Klicken Sie auf die Schaltfläche Speichern und schließen Sie dann den Dialog.

  5. Um die vorgeschlagene Abfrage zu überprüfen, klicken Sie auf die Schaltfläche Entdecken. Der Dialog Endpoint öffnet sich.

  6. Klicken Sie im Dialog Endpoint auf die Schaltfläche Entdecken, um die Abfrage auszuführen. Diese Aktion führt Folgendes aus:

    • Generiert Eingabeparameter für alle eingegebenen Beispielwerte.

    • Generiert Ausgabetabellen für alle Daten, die vom Endpunkt zurückgegeben werden.

  7. Schließen Sie den Dialog Endpoint.

  8. Klicken Sie im Abschnitt Endpoints auf die Schaltfläche Verbindung testen und dann auf die Schaltfläche Fortfahren, um den Endpunkt aufzurufen. Wenn Eingabeparameter definiert sind, werden deren Testwerte gesendet.

Configure response pagination

Um die Antwort-Paginierung zu konfigurieren, befolgen Sie diese Schritte:

  1. Wählen Sie IDE > Datenserver.

  2. Klicken Sie auf die Schaltfläche Details für Ihren neuen REST-Datenserver.

  3. Im Web Service Parameters-Panel klicken Sie auf die Schaltfläche + Parameter. Eine neue Zeile erscheint im Panel. Setzen Sie die Werte in der Zeile wie folgt:

    • Typ: Query

    • Name: Geben Sie die vom Dienst erwartete Zeichenfolge ein. (Beispiele sind Limit, _limit.)

    • Wert: Geben Sie die Anzahl der Datensätze pro Seite ein.

    • Nutzungsart: Öffnen Sie das Menü und wählen Sie Request Limit.

  4. Klicken Sie auf das -Symbol, um den Parameter zu speichern.

  5. Klicken Sie auf die Schaltfläche + Parameter. Eine neue Zeile erscheint im Panel. Wählen Sie eine der folgenden Paginierungsmethoden aus und setzen Sie die Werte entsprechend wie folgt:

    • Request Offset: Lassen Sie den Dienst eine Anzahl von Datensätzen überspringen. Setzen Sie die Werte in der Zeile wie folgt:

      • Typ: Query

      • Name: Request Offset

      • (Optional) Wert: Geben Sie die Anzahl der zu überspringenden Datensätze ein.

      • Nutzungsart: Öffnen Sie das Menü und wählen Sie Request Offset.

    • Request Page Number: Holen Sie sich eine bestimmte Seitenzahl. Setzen Sie die Werte in der Zeile wie folgt:

      • Typ: Query

      • Name: Request Page Number

      • (Optional) Wert: Geben Sie die Nummer der abzurufenden Seite ein.

      • Nutzungsart: Öffnen Sie das Menü und wählen Sie Request page number.

    • Next Token: Holen Sie sich Datensätze von einem bestimmten Punkt. Setzen Sie die Werte in der Zeile wie folgt:

      • Typ: Query

      • Name: Next Token

      • (Optional) Wert: Geben Sie den Schlüssel für den Datensatz ein, von dem aus gestartet werden soll.

      • Nutzungsart: Öffnen Sie das Menü und wählen Sie Next Token.

  6. Klicken Sie auf das -Symbol, um den Parameter zu speichern.