Veröffentlichen Sie die Jitterbit App Builder-App als REST-API-Endpunkt

Übersicht

Im App Builder können Sie einen App Builder-Server so konfigurieren, dass er eine API ist, damit die Anwendungsdaten über einen API-Schlüssel abgerufen werden können. Diese Funktion ermöglicht es Ihnen, einen API-Schlüssel und Endpunkte für Anwendungen zu erstellen. Diese Anleitung zeigt ein Beispiel mit Northwinds-Daten und nutzt einen API-Schlüssel, um eine Verbindung zu einem in einer ausgewählten Anwendung erstellten Endpunkt herzustellen.

So veröffentlichen Sie die App Builder-App als REST-API-Endpunkt

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

1. Navigieren Sie zu IDE > Sicherheitsanbieter
2. Klicken Sie im Panel zur 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 aus
5. Aktivieren Sie Aktiviert
6. Klicken Sie auf Speichern

Je nach Anwendungsfall können Sie die folgenden Eigenschaften konfigurieren:

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

Als Nächstes müssen Sie einen Endpunkt konfigurieren, um auf die Datenquelle einer Anwendung zuzugreifen:

1. Navigieren Sie zu IDE > REST APIs
2. Klicken Sie auf die Schaltfläche Endpunkte verwalten im Anwendungs-Panel
3. Wählen Sie die Anwendung aus, für die Sie den Endpunkt konfigurieren möchten. Zum Beispiel: Northwinds Design
4. Klicken Sie auf das Bleistift-Bearbeitungssymbol für die Anwendung
5. Geben Sie den Endpunktwert in das Feld Endpunkt ein. Zum Beispiel: Northwinds
6. Klicken Sie auf die Schaltfläche Fortfahren

Jetzt veröffentlichen Sie den Endpunkt, 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 Endpunkt herzustellen
3. Klicken Sie auf + Business Object im Bereich der Geschäftobjekte und wählen Sie eine Tabelle aus, um einen Wert für den Endpunkt festzulegen. Zum Beispiel: Kategorie (Quelle)
4. Klicken Sie auf das Häkchen-Symbol, um den Datensatz zu speichern
5. Klicken Sie auf das Struktur-Symbol, um zu steuern, welche Felder in der API verfügbar sind
   1. Deaktivieren Sie Standardmäßig einbeziehen und/oder löschen Sie Feld(er) vollständig, um den Zugriff über die API-Verbindung einzuschränken
6. Klicken Sie im Bereich der Tabellen auf das Datensatz öffnen-Symbol, um das Popup mit den Ressourcendetails zu erweitern und anzuzeigen
   1. Der Name der Ressource muss an die Basis-URL und den Endpunkt aus dem API-Dokument angehängt werden, um diese Informationen abzurufen
7. Klicken Sie auf Bearbeiten, um Standard-Get-Limit oder Max-Get-Limit festzulegen; diese Werte steuern die Anzahl der Datensätze, die bei GET-Anfragen an Ihren API-Endpunkt zurückgegeben werden
8. (Optional, seit App Builder 4.51.) Öffnen Sie das Menü Kompatibilität und wählen Sie dann eine der folgenden Optionen:
   • Version 1: Verwenden Sie das ursprüngliche REST-Verhalten—Insert-Ereignisse werden nicht von New-Ereignissen vorangestellt. (Standard für Endpunkte, die mit App Builder 4.50 und früher erstellt wurden.)
   • Version 2: Verwenden Sie ein verbessertes REST-Verhalten—New-Ereignisse und alle Standardregeln werden vor Insert-Ereignissen aufgerufen. (Standard für Endpunkte, die mit App Builder 4.51 und später erstellt wurden.)

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

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

Optional können Sie Rollen/Sicherheitsgruppen für die Objekte einrichten, die als Endpunkte zugegriffen werden.

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