Zum Inhalt springen

Konfigurieren und Validieren von Geschäftsobjekten als API-Endpunkte im Jitterbit App Builder

Einführung

Diese Seite zeigt Ihnen, wie Sie ein Geschäftsobjekt als API-Endpunkt bereitstellen, wie Sie benutzerdefinierte Validierungsregeln für die an diesen Endpunkt gesendeten Daten erstellen und wie Sie die vollständige Konfiguration mit einem externen API-Client testen.

Teil 1: Konfigurieren des API-Endpunkts

Dieser Abschnitt behandelt die erforderlichen Schritte, um ein Geschäftsobjekt einer Anwendung als API bereitzustellen.

1. Erstellen eines Sicherheitsanbieters für API-Schlüssel

Um sich gegen die API zu authentifizieren, benötigen Sie zunächst einen Sicherheitsanbieter. Befolgen Sie diese Schritte:

  1. Wählen Sie IDE > Sicherheitsanbieter.

  2. Klicken Sie unter Benutzerauthentifizierung auf + Benutzerauthentifizierung. Die Seite Anbieter öffnet sich.

  3. Konfigurieren Sie den Anbieter mit diesen Einstellungen:

    • Name: Geben Sie einen beschreibenden Namen ein, wie z.B. API Key.

    • Typ: Wählen Sie API Key.

    • Aktiviert: Wählen Sie, um den Anbieter zu aktivieren.

  4. Klicken Sie auf Speichern.

  5. (Optional) Klicken Sie unter Eigenschaften auf + Eigenschaft, um optionale Parameter für Ihren API-Schlüssel hinzuzufügen und zu konfigurieren.

2. Definieren eines Anwendungsendpunkts

Als Nächstes müssen Sie einen Zugangspunkt für Ihre Anwendung erstellen. Befolgen Sie diese Schritte:

  1. Wählen Sie IDE > REST APIs.

  2. Klicken Sie auf Endpunkte verwalten. Das Popup Anwendungsendpunkte öffnet sich und zeigt zugängliche Anwendungen und deren Endpunkte an.

  3. Suchen Sie die Anwendung, die Sie bereitstellen möchten, und klicken Sie auf das Bearbeiten-Symbol.

  4. Geben Sie einen Namen für den Endpunkt ein, wie z.B. endpoint-example.

  5. Klicken Sie auf das -Symbol (oder die Schaltfläche Fortfahren), um den Endpunktnamen zu speichern.

  6. Schließen Sie das Popup Anwendungsendpunkte. Ein neuer Eintrag für den Endpunkt erscheint unter Anwendung.

3. Veröffentlichen eines Geschäftsobjektendpunkts

Jetzt können Sie ein bestimmtes Geschäftsobjekt (wie eine Tabelle) aus Ihrer Anwendung veröffentlichen. Befolgen Sie diese Schritte:

  1. Gehe auf die Seite REST APIs, wähle deine Anwendung aus und klicke auf die Schaltfläche + Resource im Abschnitt Resources. Das Popup Resource öffnet sich.

  2. Setze die folgenden Werte:

    • Tabelle: Öffne das Menü und wähle die Tabelle aus, die du bereitstellen möchtest.

    • Endpoint: Gib einen Namen für den Endpoint der Tabelle ein.

  3. Klicke auf Speichern, und schließe dann das Popup Resource.

  4. Um die vollständige URL für deinen neuen Endpoint zu finden, suche deine Anwendung im Application-Panel und klicke auf das Doc-Symbol. Dies öffnet einen Bericht, der die Dokumentation des API-Endpunkts enthält.

  5. Scrolle durch die Dokumentation, um die URL für den Geschäftsdaten-Endpunkt zu finden, den du gerade erstellt hast. Kopiere diese URL, um sie später zu verwenden.

4. Generiere einen benutzerspezifischen API-Schlüssel

Der letzte Konfigurationsschritt besteht darin, einen API-Schlüssel für einen Benutzer zu generieren, der es ihm ermöglicht, sich zu authentifizieren. Befolge diese Schritte:

  1. Wähle IDE > Benutzerverwaltung.

  2. Klicke unter Benutzer auf das Datensatz öffnen-Symbol für den Benutzer, dem du API-Zugriff gewähren möchtest. Das Popup User öffnet sich.

  3. Erweitere den Abschnitt Authentifizierung und bestätige, dass der Anmeldetyp auf Interaktiv eingestellt ist.

  4. Wähle Mehr > Schlüssel. Das Popup Keys öffnet sich.

  5. Klicke auf Erstellen. Das Popup Generate Key öffnet sich.

  6. Setze Werte für die folgenden:

    • Anbieter: Wähle den Sicherheitsanbieter aus, den du im ersten Schritt erstellt hast (zum Beispiel API Key).

    • (Optional) Beschreibung: Gib eine Beschreibung für diesen Schlüssel ein.

  7. Klicke auf Speichern. Der App Builder generiert automatisch einen Wert für den Schlüssel. Kopiere den generierten Schlüsselwert, um ihn für Tests zu verwenden.

    Wichtig

    Stelle sicher, dass du den Schlüssel kopiert hast, bevor du das Popup Generate Key schließt, da er nicht erneut angezeigt werden kann.

Teil 2: Erstelle eine benutzerdefinierte Validierungsregel

In diesem Abschnitt wird erläutert, wie man eine benutzerdefinierte Regel erstellt und anwendet, um eingehende Daten zu validieren, bevor sie gespeichert werden. Dieses Beispiel erstellt eine Regel, die verhindert, dass ein Datensatz gespeichert wird, wenn sein Required Date in der Vergangenheit liegt.

1. Erstellen Sie eine Geschäftsregel zur Validierung

Befolgen Sie diese Schritte:

  1. Öffnen Sie Ihre App und wählen Sie App Workbench > Regeln.

  2. Klicken Sie auf Nach Tabelle, und wählen Sie die Tabelle aus, die Sie exponieren (zum Beispiel Order).

  3. Klicken Sie unter Regeln auf + Regel.

  4. Auf der Seite Regel konfigurieren Sie die grundlegenden Eigenschaften der Regel:

    • Name: Geben Sie einen beschreibenden Namen ein, wie zum Beispiel Validation: Date Not in Past.

    • Zweck: Wählen Sie Validierung.

    • Ziel: Die Tabelle sollte bereits ausgewählt sein (zum Beispiel Order).

  5. Klicken Sie auf Erstellen.

  6. Konfigurieren Sie die Logik der Regel:

    • Wählen Sie die Registerkarte Spalten und fügen Sie die Spalten hinzu, die die Regel benötigt. Fügen Sie in diesem Beispiel Order ID und Required Date hinzu.

    • Wählen Sie die Registerkarte Wo und fügen Sie eine Klausel hinzu, um die Fehlerbedingung zu definieren. Fügen Sie in diesem Beispiel eine Bedingung hinzu, bei der Required Date kleiner oder gleich Now() ist, um zu überprüfen, ob das erforderliche Datum in der Vergangenheit liegt.

  7. (Optional) Klicken Sie auf Validieren.

2. Hängen Sie die Validierungsregel an ein Ereignis an

Um die Regel aktiv zu machen, verknüpfen Sie sie mit einem Ereignis im Geschäftsobjekt. Befolgen Sie diese Schritte:

  1. Wählen Sie in App Workbench > Regeln, mit Nach Tabelle ausgewählt, dieselbe Tabelle aus (Order in diesem Beispiel).

  2. Klicken Sie auf das Ereignisse-Symbol für (in diesem Beispiel) Orders (Source). Das Popup Alle Ereignisse öffnet sich.

  3. Klicken Sie in der Zeile Speichern auf Regelereignisdetails.

  4. Klicken Sie unter Validierungen auf Registrieren. Das Popup Validierung öffnet sich.

  5. Wählen Sie im Menü Regel die Validierungsregel aus, die Sie gerade erstellt haben (Validation: Date Not in Past).

  6. Konfigurieren Sie die Validierungsaktion wie folgt:

    • Bindung: Wählen Sie Implizit.

    • Fehler: Wählen Sie Fehler bei zurückgegebenen Daten.

    • Schweregrad: Wählen Sie Fehler.

    • Nachricht: Geben Sie die Fehlermeldung ein, die angezeigt werden soll, wenn die Validierung fehlschlägt, wie zum Beispiel Das erforderliche Datum kann nicht in der Vergangenheit liegen.

  7. Klicken Sie auf Speichern.

Teil 3: Testen des API-Endpunkts

In diesem Abschnitt wird erläutert, wie der Endpunkt mit einem Drittanbieter-API-Client, wie Postman, getestet werden kann, um sicherzustellen, dass er wie erwartet funktioniert.

1. Testclient konfigurieren

Befolgen Sie diese Schritte:

  1. Erstellen Sie in Postman eine neue POST-Anfrage.

  2. Fügen Sie im URL-Feld die Endpunkt-URL ein, die Sie aus der API-Dokumentation kopiert haben.

  3. Konfigurieren Sie die Authentifizierung:

    • Wählen Sie die Registerkarte Authorization.

    • Wählen Sie für Type API Key.

    • Geben Sie für Key X-API-Key ein.

    • Fügen Sie für Value den Benutzer-API-Schlüssel ein, den Sie zuvor kopiert haben.

  4. Konfigurieren Sie den Anfrageinhalt:

    • Wählen Sie die Registerkarte Body.

    • Wählen Sie die Option Raw.

    • Wählen Sie im Format-Dropdown JSON.

2. Testen der Validierungsregel (Fehlerfall)

Befolgen Sie diese Schritte:

  1. Fügen Sie im JSON-Inhalt einen Datensatz ein, um den Validierungsfehler auszulösen. Verwenden Sie in diesem Beispiel ein Required Date, das in der Vergangenheit liegt.

    Beispiel für einen Fehlerdatensatz
    {
    "OrderID": 11255,
    "OrderDate": "2014-05-26T00:00:00",
    "RequiredDate": "2014-05-20T00:00:00",
    "ShippedDate": "2014-05-28T00:00:00",
    "ShipCost": 1000.50,
    "ShipName": "Test Site",
    "ShipAddress": "508 Main Street",
    "ShipCity": "Harwich",
    "ShipState": "MA",
    "ShipZip": "02630",
    "ShipCountry": "USA",
    "AddedOn": null,
    "AddedBy": null,
    "EmployeeID": "0f9c520c-1890-11f1-b283-ab1e4a99c4ce",
    "ShipperID": "f4b1df98-188f-11f1-90ba-7a85ad06b57c"
}

  2. Klicken Sie auf Send.

  3. Überprüfen Sie die Antwort. Sie sollten einen Validierungsfehler mit der benutzerdefinierten Nachricht sehen, die Sie konfiguriert haben: Das erforderliche Datum darf nicht in der Vergangenheit liegen. Der Datensatz wird nicht erstellt.

3. Testen des Endpunkts (Erfolgsfall)

Befolgen Sie diese Schritte:

  1. Ändern Sie im JSON-Inhalt die Daten, sodass sie gültig sind. Ändern Sie in diesem Beispiel das RequiredDate auf ein Datum in der Zukunft.

    Beispiel für einen Erfolgsdatensatz
    {
    "OrderID": 11255,
    "OrderDate": "2014-05-26T00:00:00",
    "RequiredDate": "2114-05-20T00:00:00",
    "ShippedDate": "2014-05-28T00:00:00",
    "ShipCost": 1000.50,
    "ShipName": "Test Site",
    "ShipAddress": "508 Main Street",
    "ShipCity": "Harwich",
    "ShipState": "MA",
    "ShipZip": "02630",
    "ShipCountry": "USA",
    "AddedOn": null,
    "AddedBy": null,
    "EmployeeID": "0f9c520c-1890-11f1-b283-ab1e4a99c4ce",
    "ShipperID": "f4b1df98-188f-11f1-90ba-7a85ad06b57c"
}

  2. Klicken Sie auf Send.

  3. Überprüfen Sie die Antwort. Sie sollten den Status 200 OK sehen, und der Antwortinhalt sollte keinen Validierungsfehler enthalten.

  4. Um dies zu bestätigen, navigieren Sie zur Datentabelle in Ihrer App Builder-Anwendung und überprüfen Sie, ob der neue Datensatz erfolgreich erstellt wurde.