Zum Inhalt springen

Verwandeln Sie Ihre Kontakte in Urlaubsgeld mit unserem neuen Kundenempfehlungsprogramm! Erfahren Sie mehr

✕

Diese Dokumentation gilt für Version 4 und höher von App Builder, dem neuen Namen für Vinyl. Hier gelangen Sie zur Vinyl-Dokumentation.

✕

Veröffentlichen Sie die Jitterbit App Builder App als REST API Endpoint

Übersicht

Im App Builder können Sie einen App Builder Server als API konfigurieren, sodass die Anwendungsdaten über einen API -Schlüssel abgerufen werden können. Mit dieser Funktion können Sie einen API -Schlüssel und Endpoints für Anwendungen erstellen. Diese Anleitung zeigt ein Beispiel mit Northwinds-Daten und verwendet einen API Schlüssel, um eine Verbindung zu einem in einer ausgewählten Anwendung erstellten Endpoint herzustellen.

Notiz

Dieser Artikel beschreibt die Schritte zum Veröffentlichen einer App Builder App als REST API Endpoint. Wenn Sie eine App Builder App in ein LP packen und in anderen Umgebungen einsetzen, bleibt die Endpoint unter IDE > REST- APIs erhalten. Alle anderen Konfigurationen müssen in zusätzlichen Umgebungen manuell neu erstellt werden.

So veröffentlichen Sie die App Builder App als REST API Endpoint

Zuerst müssen Sie einen API -Schlüssel für den Sicherheitsanbieter einrichten, um die Authentifizierung für den Zugriff auf die Endpoints bereitzustellen:

  1. Navigieren Sie zu IDE > Sicherheitsanbieter
  2. Klicken Sie im Bereich „Benutzerauthentifizierung“ auf + Benutzerauthentifizierung
  3. Weisen Sie dem Anbieter einen Namen zu. Zum Beispiel: API -Schlüssel
  4. Wählen Sie API -Schlüssel als Typwert
  5. Aktivieren Sie die Option Aktiviert
  6. Klicken Sie auf Speichern

Abhängig von Ihrem Anwendungsfall können Sie die folgenden Eigenschaften konfigurieren:

  1. Wenn Sie die API zum Testen in die Adressleiste Ihres Browsers eingeben möchten (nicht sehr sicher), dann
    1. Klicken Sie im Eigenschaftenfenster auf + Eigenschaft
    2. Wählen Sie AllowApiKeyInQueryString als Parameter
    3. Geben Sie True als Wert ein.
    4. Klicken Sie auf das Häkchen, um den Datensatz zu speichern.
  2. Wenn Sie HTTP verwenden (nicht empfohlene Konfiguration), müssen Sie Folgendes hinzufügen:
    1. Klicken Sie auf Erstellen.
    2. Wählen Sie AllowInsecureHttp als Parameter
    3. Geben Sie True für den Wert ein
    4. Klicken Sie auf das Häkchen, um den Datensatz zu speichern

Als Nächstes müssen Sie einen Endpoint konfigurieren, um auf eine Anwendungsdatenquelle zuzugreifen:

  1. Navigieren Sie zu IDE > REST APIs
  2. Klicken Sie im Anwendungsfenster auf die Schaltfläche Endpoints verwalten
  3. Wählen Sie die Anwendung aus, in der Sie den Endpoint konfigurieren möchten. Beispiel: Northwinds Design
  4. Klicken Sie auf das Bleistift-Bearbeitungssymbol für die Anwendung
  5. Geben Sie den Endpoint in das Feld Endpoint ein. Beispiel: Northwinds
  6. Klicken Sie auf die Schaltfläche Weiter

Als Nächstes veröffentlichen Sie den Endpoint, den Sie im vorherigen Schritt erstellt haben:

  1. Navigieren Sie zu IDE > REST APIs
  2. Klicken Sie auf das Doc-Symbol für die API, um Informationen anzuzeigen, die Sie später benötigen, um eine Verbindung zu diesem Endpoint herzustellen
  3. Klicken Sie im Bereich „Business-Objekte“ auf „+ Business-Objekt“ und wählen Sie eine Tabelle aus, um einen Wert für den Endpoint festzulegen. Beispiel: Kategorie (Quelle)
  4. Klicken Sie auf das Häkchen-Symbol, um den Datensatz zu speichern
  5. Klicken Sie auf das Symbol Struktur, um zu steuern, welche Felder in der API verfügbar sind
    1. Deaktivieren Sie Standardmäßig einschließen und/oder löschen Sie das/die Feld(er) vollständig, um den Zugriff über die API Verbindung einzuschränken
  6. Klicken Sie im Tabellenbereich auf das Symbol Datensatz öffnen, um das Popup „Ressourcendetails“ zu erweitern und anzuzeigen
    1. Der Name der Ressource muss an die Basis URL und den Endpoint aus dem API -Dokument angehängt werden, um diese Informationen abzurufen
  7. Klicken Sie auf Bearbeiten, um das Standard-Get-Limit oder das Get-Max-Limit festzulegen. Diese Werte steuern die Anzahl der Datensätze, die bei GET-Aufrufen an Ihren API Endpoint zurückgegeben werden.

Zuletzt konfigurieren Sie API -Schlüssel für bestimmte Benutzer:

  1. Navigieren Sie zu IDE > Benutzerverwaltung
  2. Wählen Sie einen vorhandenen Benutzer aus oder erstellen Sie einen neuen Benutzer für den API -Aufruf
    1. Der Benutzer muss mit dem Anmeldetyp Interaktiv konfiguriert sein
    2. Der Benutzer benötigt keine lokale Authentifizierung
  3. Klicken Sie im ausgewählten/erstellten Benutzerdatensatz auf das Symbol Schlüssel
  4. Klicken Sie auf Erstellen und wählen Sie den im ersten Schritt erstellten API Schlüssel als Provider aus
  5. Klicken Sie auf Speichern
  6. Der generierte Schlüssel ist das, was der Benutzer für den Zugriff auf die veröffentlichte API verwendet

Optional können Sie Rollen/Sicherheitsgruppen für die Objekte einrichten, auf die als Endpoints zugegriffen wird.

Um die Verwendung Ihrer neuen API Endpoints zu testen oder einzurichten, verwenden Sie den API -Schlüssel aus dem vorherigen Schritt, die Basis URL und Endpoint-Informationen aus dem API Dokument und den Namen aus den Ressourcendetails.

Restobjekt 8