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 zur 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:

Erstellen Sie einen REST-Datenquellenserver.
Konfigurieren Sie die Anfrage-Header.
Konfigurieren Sie den Anfrageinhalt.
Konfigurieren Sie die Abfragezeichenfolgenparameter.
Erstellen Sie REST-Endpunkte für jede aufgerufene API-Methode.
Fügen Sie REST-Endpunkte hinzu.
(Optional) Überschreiben Sie die Inhaltstypen der Anfrage/Antwort des Endpunkts.
(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:

Wählen Sie IDE > Datenserver.
Klicken Sie auf die Schaltfläche + Server.
Geben Sie im Abschnitt Servereinstellungen die folgenden Felder ein:
- Servername: Geben Sie einen Namen für den REST-Server ein.
- Typ: Wählen Sie REST API.
- URL: Geben Sie die URL des Servers ein, mit dem Sie sich verbinden möchten.
  
  Hinweis
  
  Endpunkte werden im nächsten Abschnitt konfiguriert.
- Anfrageinhaltstyp und Antwortinhaltstyp: Wählen Sie die Inhaltstypen für Anfrage und Antwort aus. (Typischerweise kommunizieren REST-Server über JSON.)
(Optional) Erweitern Sie den Abschnitt Sicherheitseinstellungen und setzen Sie dann Folgendes:
- Sicherheitsanbieter: Wählen Sie den erforderlichen 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 (der im nächsten Abschnitt konfiguriert wird).
(Optional) Beschreibung: Geben Sie eine Beschreibung für diesen Server ein.
Klicken Sie auf die Speichern-Schaltfläche und schließen Sie den Dialog. Sie sollten Ihren neuen REST-Datenserver in der Liste 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:

Wählen Sie IDE > Datenserver.
Klicken Sie auf die Datensatz öffnen-Schaltfläche für Ihren neuen REST-Datenserver.
Im Server-Popup, unter Servereinstellungen, klicken Sie auf das Endpoints -Symbol.
Im Webdienstparameter-Panel klicken Sie auf die + Parameter-Schaltfläche. Eine neue Zeile erscheint im Panel. Setzen Sie die Werte wie folgt:
- Typ: 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: (Optional) Wählen Sie den Verwendungstyp für diesen Parameter.
Klicken Sie auf das -Symbol, um den Parameter zu speichern.

Anfrage-Body konfigurieren

Um die Struktur der Nutzlast bei Verwendung der Methoden POST oder PUT zu ändern, befolgen Sie diese Schritte:

Wählen Sie im Endpoints-Panel Mehr > Randfall. Der Dialog Endpoint Randfall öffnet sich.
Klicken Sie auf die Bearbeiten-Schaltfläche.
Im Abschnitt Anfrage setzen Sie Anfrage-Body auf einen der folgenden Werte:
- Objekt: (Standard) Die Nutzlast wird als einzelnes JSON-Objekt gesendet. Verwenden Sie dies, wenn Sie einen einzelnen Datensatz erstellen oder aktualisieren.
  Beispiel
```
{
  "id": 123,
  "name": "A single record"
}
```
- Array: Die Nutzlast wird als JSON-Array von Objekten gesendet. Verwenden Sie dies, um eine Batch-Anfrage mit mehreren Datensätzen in einer Anfrage zu senden.
  Beispiel
```
[
  { "id": 123, "name": "First record" },
  { "id": 124, "name": "Second record" }
]
```
- Root überspringen: Für Nutzlasten, die in einem obersten Objekt eingewickelt sind, ignoriert diese Option den Wrapper und sendet das erste Kind-Element als Nutzlast. Dies ist nützlich für 'drill down' Szenarien.
  
  Zum Beispiel, wenn das System eine Payload mit einem data-Wrapper generiert, sendet Skip Root nur den Inhalt innerhalb von data.
  Beispiel-Payload gesendet
```
{
  "id": 123,
  "name": "The actual record"
}
```
Klicken Sie auf die Speichern-Schaltfläche und schließen Sie dann den Dialog.

Konfigurieren von Abfragezeichenfolgenparametern

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

Wählen Sie IDE > Datenserver.
Klicken Sie auf die Datensatz öffnen-Schaltfläche für Ihren neuen REST-Datenserver.
Im Server-Popup, unter Servereinstellungen, klicken Sie auf das Endpoints -Symbol.
Im Webdienstparameter-Panel klicken Sie auf die + Parameter-Schaltfläche. Eine neue Zeile erscheint im Panel. Setzen Sie die Werte in der Zeile wie folgt:
- Typ: Wählen Sie Abfrage.
- Name: Geben Sie den Namen des Abfragezeichenfolgenparameters ein.
- Wert: Geben Sie den Wert des Abfragezeichenfolgenparameters ein.
- Verwendungstyp: (Optional) Wählen Sie den Verwendungstyp für diesen Parameter.
Klicken Sie auf das -Symbol, um den 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, folgen Sie diesen Schritten:

Wählen Sie IDE > Datenserver.
Klicken Sie auf die Datensatz öffnen-Schaltfläche für Ihren neuen REST-Datenserver.
Im Server-Popup, unter Servereinstellungen, klicken Sie auf das Endpoints -Symbol.
Im Endpoints-Panel klicken Sie auf die + Endpunkt-Schaltfläche. Eine neue Zeile erscheint im Panel. Setzen Sie die Werte in der Zeile wie folgt:
- Name: Geben Sie den Namen des Endpunkts ein.
- Endpunkt: Geben Sie den Endpunkt ein. (Dieser Wert wird an die URL des REST-Datenservers angehängt, die in einem früheren Abschnitt festgelegt wurde.)
- Methode: Wählen Sie die HTTP-Methode für den Endpunkt.
Klicken Sie auf das -Symbol, um den Endpunkt zu speichern.

Endpunkt-Anforderungs-/Antwortinhaltstypen überschreiben

Der Standardwert für Anforderungs- und Antwortinhaltstypen wird vom Inhaltstyp des Servers übernommen. Die verfügbaren Inhaltstypwerte sind wie folgt:

Datei
Formular
JSON
Multipart
Klartext
XML

Um die Anforderungs- oder Antwortinhaltstypen des Endpunkts zu überschreiben, befolgen Sie diese Schritte:

Wählen Sie im Endpoints-Panel Mehr > Edge Case. Der Dialog Endpoint Edge Case öffnet sich.
Klicken Sie auf die Schaltfläche Bearbeiten.
Im Abschnitt Inhaltstyp legen Sie Werte für Folgendes fest:
- Anforderung: Wählen Sie den überschreibenden Anforderungsinhaltstyp aus.
- Antwort: Wählen Sie den überschreibenden Antwortinhaltstyp aus.
Klicken Sie auf die Schaltfläche Speichern und schließen Sie dann den Dialog.
Um die vorgeschlagene Abfrage zu überprüfen, klicken Sie auf die Schaltfläche Entdecken. Der Dialog Endpoint öffnet sich.
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.
Schließen Sie den Dialog Endpoint.
Klicken Sie im Abschnitt Endpoints auf die Schaltfläche Verbindung testen und klicken Sie dann auf die Schaltfläche Fortfahren, um den Endpunkt aufzurufen. Wenn Eingabeparameter definiert sind, werden deren Testwerte gesendet.

Antwort-Paginierung konfigurieren

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

Wählen Sie IDE > Datenserver.
Klicken Sie auf die Schaltfläche Datensatz öffnen für Ihren neuen REST-Datenserver.
Klicken Sie im Popup Server unter Servereinstellungen auf das Symbol Endpoints .
Klicken Sie im Panel Webdienstparameter auf die Schaltfläche + Parameter. Eine neue Zeile erscheint im Panel. Legen Sie die Werte in der Zeile wie folgt fest:
- Typ: Wählen Sie Abfrage.
- Name: Geben Sie die vom Dienst erwartete Zeichenfolge ein. (Beispiele sind Limit, _limit.)
- Wert: Geben Sie die Anzahl der Datensätze pro Seite ein.
- Verwendungstyp: Öffnen Sie das Menü und wählen Sie dann Anforderungsgrenze.
Klicken Sie auf das -Symbol, um den Parameter zu speichern.
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:
- Anforderungsversatz: Lassen Sie den Dienst eine Anzahl von Datensätzen überspringen. Setzen Sie die Werte in der Zeile wie folgt:
  - Typ: Abfrage
  - Name: Anforderungsversatz
  - (Optional) Wert: Geben Sie die Anzahl der zu überspringenden Datensätze ein.
  - Verwendungstyp: Öffnen Sie das Menü und wählen Sie dann Anforderungsversatz.
- Anforderungsseitenzahl: Holen Sie sich eine bestimmte Seitenzahl. Setzen Sie die Werte in der Zeile wie folgt:
  - Typ: Abfrage
  - Name: Anforderungsseitenzahl
  - (Optional) Wert: Geben Sie die Nummer der abzurufenden Seite ein.
  - Verwendungstyp: Öffnen Sie das Menü und wählen Sie dann Anforderungsseitenzahl.
- Nächster Token: Holen Sie sich Datensätze von einem bestimmten Punkt. Setzen Sie die Werte in der Zeile wie folgt:
  - Typ: Abfrage
  - Name: Nächster Token
  - (Optional) Wert: Geben Sie den Schlüssel für den Datensatz ein, von dem aus gestartet werden soll.
  - Verwendungstyp: Öffnen Sie das Menü und wählen Sie dann Nächster Token.
Klicken Sie auf das -Symbol, um den Parameter zu speichern.