REST-Datenquelle im Jitterbit App Builder

Einführung

Mit der REST-Datenquelle können Sie App Builder mit verschiedenen REST-Servern (einschließlich anderer Instanzen von App Builder) verbinden oder mit REST-Objekten verwenden. Die Konfiguration eines REST-Datenquellenservers wird für alle REST- Endpoints verwendet.

Das Einrichten einer REST-Datenquelle umfasst die folgenden Schritte:

1. Erstellen Sie einen REST-Datenquellenserver.

2. Anforderungsheader konfigurieren.

3. Abfrage konfigurieren.

4. REST- Endpoints erstellen für jede aufgerufene API Methode.

5. REST- Endpoints hinzufügen.

6. (Optional) Inhaltstypen für Endpoint /-antworten überschreiben.

7. (Optional) Antwort-Paginierung konfigurieren.

Erstellen eines REST-Datenservers

So erstellen Sie einen REST-Datenserver:

1. Wählen Sie IDE > Datenserver.

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

3. Legen Sie im Abschnitt Servereinstellungen die folgenden Felder fest:

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

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

   • URL: Geben Sie die URL des Servers ein, mit dem eine Verbindung hergestellt werden soll.

     Notiz

     Endpoints werden im nächsten Abschnitt konfiguriert.

   • Anforderungsinhaltstyp und Antwortinhaltstyp: Wählen Sie die Anforderungs- und Antwortinhaltstypen aus. (REST-Server kommunizieren normalerweise über JSON.)

4. (Optional) Erweitern Sie den Abschnitt Sicherheitseinstellungen und legen Sie dann Folgendes fest:

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

   • Benutzername: Geben Sie den Benutzernamen für den Sicherheitsanbieterdienst ein.

   • Passwort: Geben Sie das Passwort für den Sicherheitsanbieterdienst ein.

   Tipp

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

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

6. Klicken Sie auf die Schaltfläche Speichern und schließen Sie dann das Dialogfeld.

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

Konfigurieren von Anforderungsheadern

Bei den meisten REST-Diensten müssen Sie mithilfe des Header einen API Schlüssel übergeben.

Um den Header zu konfigurieren, gehen Sie folgendermaßen vor:

1. Wählen Sie IDE > Datenserver.

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

3. Klicken Sie im Bereich Webdienstparameter auf die Schaltfläche + Parameter. Im Bereich wird eine neue Zeile angezeigt. Legen Sie die Werte wie folgt fest:

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

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

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

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

4. Klicken Sie auf die Symbol zum Speichern des Parameters.

Konfigurieren von Abfrage

Wenn Sie gemeinsame Abfrage für die Verwendung an allen Endpunkten haben, können Sie diese mit den folgenden Schritten konfigurieren:

1. Wählen Sie IDE > Datenserver.

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

3. Klicken Sie im Bereich Webdienstparameter auf die Schaltfläche + Parameter. Eine neue Zeile wird im Bereich angezeigt. Legen Sie die Werte in der Zeile wie folgt fest:

   • Typ: Abfrage

   • Name: Geben Sie den Namen des Abfrage ein.

   • Wert: Geben Sie den Wert des Abfrage ein.

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

4. Klicken Sie auf die Symbol zum Speichern der Webserver-Parameter.

Hinzufügen von REST- Endpoints

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

Um einen Endpoint hinzuzufügen, gehen Sie folgendermaßen vor:

1. Wählen Sie IDE > Datenserver.

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

3. Klicken Sie im Bereich Endpoints auf die Schaltfläche + Endpoint. Eine neue Zeile wird im Bereich angezeigt. Legen Sie die Werte in der Zeile wie folgt fest:

   • Name: Geben Sie den Namen des Endpoint ein.

   • Endpoint: Geben Sie den Endpoint ein. (Dieser Wert wird an die URL des REST-Datenservers angehängt, die Sie zuvor festgelegt haben.)

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

4. Klicken Sie auf die Symbol, um den Endpoint zu speichern.

Inhaltstypen für Endpoint /-antworten überschreiben

Der Standardwert für die Inhaltstypen „Anfrage“ und „Antwort“ wird vom Server-Inhaltstyp übernommen. Die verfügbaren Inhaltstypwerte sind:

• Datei
• Formular
• JSON
• Multipart
• Klartext XML

Um die Inhaltstypen der Endpoint oder -antwort zu überschreiben, führen Sie die folgenden Schritte aus:

1. Wählen Sie im Bereich „Endpoints “ Mehr > Randfall. Das Dialogfeld Endpoint-Randfall wird geöffnet.

2. Klicken Sie auf die Schaltfläche Bearbeiten.

3. Legen Sie im Abschnitt Inhaltstyp Werte für Folgendes fest:

   • Anfrage: Öffnen Sie das Menü und wählen Sie dann den übergeordneten Anfrageinhaltstyp aus.

   • Antwort: Öffnen Sie das Menü und wählen Sie dann den übergeordneten Antwortinhaltstyp aus.

4. Klicken Sie auf die Schaltfläche Speichern und schließen Sie dann das Dialogfeld.

5. Um die vorgeschlagene Abfrage zu überprüfen, klicken Sie auf die Schaltfläche Erkennen. Das Dialogfeld Endpoint wird geöffnet.

6. Klicken Sie im Dialogfeld Endpoint auf die Schaltfläche Erkennen, um die Abfrage auszuführen. Diese Aktion bewirkt Folgendes:

   • Generiert Eingabeparameter für alle eingegebenen Beispieleingaben.

   • Generiert Ausgabetabellen für alle vom Endpoint zurückgegebenen Daten.

7. Schließen Sie das Dialogfeld Endpoint.

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

Konfigurieren der Antwortpaginierung

So konfigurieren Sie die Antwortpaginierung:

1. Wählen Sie IDE > Datenserver.

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

3. Klicken Sie im Bereich Webdienstparameter auf die Schaltfläche + Parameter. Eine neue Zeile wird angezeigt. Legen Sie die Werte wie folgt fest:

   • Typ: Abfrage

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

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

   • Nutzungstyp: Öffnen Sie das Menü und wählen Sie Anforderungslimit.

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

5. Klicken Sie auf die Schaltfläche + Parameter. Eine neue Zeile wird im Bedienfeld angezeigt. Wählen Sie eine der folgenden Paginierungsmethoden und legen Sie die Werte wie folgt fest:

   • Anforderungsoffset: Der Dienst soll eine bestimmte Anzahl von Datensätzen überspringen. Legen Sie die Werte in der Zeile wie folgt fest:

     • Typ: Abfrage

     • Name: Anforderungsoffset

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

     • Verwendungstyp: Öffnen Sie das Menü und wählen Sie Anforderungsoffset.

   • Seitenzahl anfordern: Rufen Sie eine bestimmte Seitenzahl ab. Legen Sie die Werte in der Zeile wie folgt fest:

     • Typ: Abfrage

     • Name: Seitenzahl anfordern

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

     • Verwendungstyp: Öffnen Sie das Menü und wählen Sie Seitenzahl anfordern.

   • Nächstes Token: Rufen Sie Datensätze von einem bestimmten Punkt ab. Legen Sie die Werte in der Zeile wie folgt fest:

     • Typ: Abfrage

     • Name: Nächstes Token

     • (Optional) Wert: Geben Sie den Schlüssel ein, mit dem der Datensatz beginnen soll.

     • Verwendungstyp: Öffnen Sie das Menü und wählen Sie Nächstes Token.

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