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

Einführung

Im App Builder können Sie einen Datenserver 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 verwendet einen API-Schlüssel, um eine Verbindung zu einem in einer ausgewählten Anwendung erstellten Endpunkt herzustellen.

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

1. Richten Sie einen Sicherheitsanbieter-API-Schlüssel ein

Um einen Sicherheitsanbieter-API-Schlüssel einzurichten, der die Authentifizierung zum Zugriff auf die Endpunkte bereitstellt, befolgen Sie diese Schritte:

1. Wählen Sie IDE > Sicherheitsanbieter.

2. Klicken Sie im Panel Benutzerauthentifizierung auf + Benutzerautorisierung.

3. Weisen Sie dem Anbieter einen Namen zu. Zum Beispiel: API Key.

4. Wählen Sie API Key als Typ aus.

5. Aktivieren Sie die Auswahl von 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 Adresszeile Ihres Browsers zum Testen eingeben möchten (nicht sehr sicher), dann:

   1. Klicken Sie im Panel Eigenschaften auf + Eigenschaft.

   2. Wählen Sie AllowApiKeyInQueryString als Parameter aus.

   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 empfohlen), fügen Sie Folgendes hinzu:

   1. Klicken Sie auf Erstellen.

   2. Wählen Sie AllowInsecureHttp als Parameter aus.

   3. Geben Sie True für den Wert ein.

   4. Klicken Sie auf das Häkchen, um den Datensatz zu speichern.

2. Konfigurieren Sie einen Endpunkt

Um einen Endpunkt zu konfigurieren, um auf die Datenquelle einer Anwendung zuzugreifen, befolgen Sie diese Schritte:

1. Wählen Sie IDE > REST APIs.

2. Klicken Sie auf die Schaltfläche Manage Endpoints im Anwendungsbereich.

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 Bearbeitungssymbol für die Anwendung.

5. Geben Sie den Endpunktwert in das Feld Endpoint ein. Zum Beispiel: northwinds.

6. Klicken Sie auf die Schaltfläche Proceed, und schließen Sie das Popup.

3. Einen Endpunkt veröffentlichen

Um den im vorherigen Schritt erstellten Endpunkt zu veröffentlichen:

1. Wählen Sie IDE > REST APIs.

2. Klicken Sie auf das Doc-Symbol für die API, um Informationen anzuzeigen, die später benötigt werden, um eine Verbindung zu diesem Endpunkt herzustellen.

3. Klicken Sie auf + Resource im Bereich Resources. Das Ressourcen-Popup öffnet sich.

4. Wählen Sie eine Tabelle aus, um einen Wert für den Endpunkt festzulegen.

5. Klicken Sie auf Save, und schließen Sie das Popup.

6. Klicken Sie im Bereich Resources auf das Structure-Symbol, um zu steuern, welche Felder in der API verfügbar sind.

   • Deaktivieren Sie Include By Default und/oder löschen Sie Feld(er) vollständig, um den Zugriff über die API-Verbindung zu beschränken, und schließen Sie das Popup.

7. Klicken Sie im Bereich Resources auf das Open Record-Symbol, um das Resource-Popup 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.

   2. Legen Sie Default Get Limit oder Get Max Limit fest. Diese Werte steuern die Anzahl der Datensätze, die bei GET-Anfragen an Ihren API-Endpunkt zurückgegeben werden.

   3. (Optional, seit App Builder 4.51.) Öffnen Sie das Menü Compatibility, und wählen Sie 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 erstellt wurden.)

      • Version 3: (Seit App Builder 4.52.) Gleich wie Version 2, aber APIs geben den logischen Wert anstelle des Speicherwerts zurück. Zum Beispiel werden boolesche Werte als true oder false anstelle von 1 oder 0 zurückgegeben. (Standard für Endpunkte, die mit App Builder 4.52 und später erstellt wurden.)

   4. Schließen Sie das Resource-Popup.

4. API-Schlüssel für Benutzer konfigurieren

Um API-Schlüssel für spezifische Benutzer zu konfigurieren:

1. Navigieren Sie zu IDE > Benutzerverwaltung.

2. Wählen Sie einen vorhandenen Benutzer aus oder erstellen Sie einen neuen Benutzer, der für den API-Aufruf verwendet werden soll.

   • Der Benutzer muss mit dem Anmeldetyp Interaktiv konfiguriert sein.

   • Der Benutzer muss keine Lokale Authentifizierung haben.

3. Klicken Sie im ausgewählten/erstellten Benutzerdatensatz auf das Keys-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.

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.