Zum Inhalt springen

REST-Datenquelle im Jitterbit App Builder

Übersicht

Die REST-Datenquelle bietet Entwicklern die Möglichkeit, eine Verbindung herzustellen App Builder zu verschiedenen REST-Servern, einschließlich anderer Instanzen von App Builder Das Einrichten einer REST-Datenquelle umfasst drei grundlegende Schritte:

  1. Erstellen und Konfigurieren des REST-Datenquellenservers
  2. Erstellen Sie REST- Endpoints für jede API -Methode, die Sie aufrufen werden
  3. Für REST-CRUD- APIs optionales Erstellen eines REST-Superobjekts

REST-Datenquellenserver

Die REST-Datenquellenserverkonfiguration enthält Informationen, die an allen REST- Endpoints verwendet werden.

Erstellen des REST-Datenservers

  • Navigieren Sie zu IDE > Datenserver
  • Klicken Sie auf + Server
  • Geben Sie einen Servernamen ein
  • Wählen Sie unter Webdienste den Typ REST API aus.

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

    Notiz

    Endpoints, die Sie im nächsten Abschnitt konfigurieren, werden an diese Haupt URL angehängt. Wenn wir einen REST-Server-Endpoint von annehmen https://api.google.com/rest/v1/analytics Die Konfiguration könnte so aussehen:

    Server-URL: https://api.google.com/rest/v1 Endpoint: analytics

  • Geben Sie den Inhaltstyp der Anfrage und Antwort ein. Normalerweise kommunizieren REST-Server über JSON

  • Geben Sie bei Bedarf Sicherheitseinstellungen ein
    • Die meisten REST- APIs verwenden einen API Schlüssel im Header, den wir in einem späteren Abschnitt konfigurieren.
  • Klicken Sie auf Speichern und schließen Sie den Dialog

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

Konfigurieren von Anforderungsheadern

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

  • Navigieren Sie zu IDE > Datenserver
  • Klicken Sie auf die Schaltfläche Details für den von Ihnen konfigurierten Datenserver.
  • Klicken Sie im Bereich „Webdienstparameter“ auf + Parameter
    • Wählen Sie Header als Typ
    • Fügen Sie den Namen des Header-Parameters hinzu
      • ZB für App Builder An REST-Server wird der API-Schlüssel mit „X-API-Key"
  • Fügen Sie den Wert des Header-Parameters hinzu
  • Klicken Sie zum Speichern auf das Häkchensymbol

Konfigurieren von Abfrage

Wenn Sie über gemeinsame Abfrage verfügen, die Sie an allen Endpunkten verwenden können, können Sie diese wie folgt konfigurieren:

  • Navigieren Sie zu IDE > Datenserver
  • Klicken Sie auf die Schaltfläche Details für den von Ihnen konfigurierten Datenserver.
  • Klicken Sie im Bereich „Webdienstparameter“ auf + Parameter
    • Wählen Sie Abfrage als Typ
    • Fügen Sie den Namen des Abfrage hinzu
    • Fügen Sie den Wert des Abfrage hinzu
  • Klicken Sie zum Speichern auf das Häkchensymbol

REST- Endpoints

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

Hinzufügen eines Endpoint

  • Navigieren Sie zu IDE > Datenserver
  • Klicken Sie auf die Schaltfläche Details für den von Ihnen konfigurierten Datenserver.
  • Klicken Sie im Bereich „Endpoints“ auf + Endpoint
    • Geben Sie den Namen des Endpoint ein
    • Geben Sie den Endpoint ein. Dieser Wert wird an die URL des REST-Datenservers angehängt
      • Wenn beispielsweise die URL unseres REST-Datenservers auf https://api.google.com/rest/v1 eingestellt ist, führt ein Endpoint von „analytics“ zu der folgenden URL: https://api.google.com/rest/v1/analytics
  • Wählen Sie die HTTP-Methode für den Endpoint
  • Wenn Sie den Inhaltstyp Antwort oder Anfrage des Endpoint überschreiben möchten, klicken Sie auf Mehr und wählen Sie Edge Case
    • Im Abschnitt Inhaltstyp stehen für diese Konfiguration zwei Felder zur Verfügung:
      • Anfrage: Der ausgewählte Wert überschreibt den Inhaltstyp der Serveranfrage.
      • Antwort: Der ausgewählte Wert überschreibt den Inhaltstyp der Serverantwort
    • Der Standardwert für Anforderung und Antwort ist nicht festgelegt und wird vom Inhaltstyp des Servers übernommen. Zu den Werten für den Inhaltstyp gehören Datei, JSON, Multipart, Nur-Text und XML.
  • Klicken Sie auf Speichern
  • Klicken Sie auf Entdecken, um die vorgeschlagene Abfrage zu überprüfen, und klicken Sie erneut auf Entdecken, um die Abfrage auszuführen.
    • Dadurch werden Eingabeparameter für alle eingegebenen Beispieleingaben generiert
    • Außerdem werden Ausgabetabellen für alle Daten generiert, die vom Endpoint zurückkommen
  • Klicken Sie auf Verbindung testen und dann auf Weiter, um den Endpoint aufzurufen. Wenn Eingabeparameter definiert sind, wird ihr Testwert gesendet.

Ressourcen