API Antwortaktivität

Einführung

Eine API -Antwort-Aktivität unter Verwendung ihrer vorkonfigurierten API Verbindung, gibt Daten an eine Custom API-Manager API zurück und soll als Ziel zum Verbrauchen von Daten in einer Operation verwendet werden.

Die API -Antwort-Aktivität kann mithilfe eines JSON-, XML-, CSV- oder XSD Schema konfiguriert werden. Um mit einer API -Verbindung über ein WSDL Schema zu interagieren, verwenden Sie eine API SOAP Antwort-Aktivität stattdessen.

Informationen zur Beziehung zwischen API Connector-Aktivitäten und API-Manager APIs finden Sie in diesen Ressourcen:

• API-Manager API -Typen

• Custom API Konfiguration

• Erstellen einer einfachen benutzerdefinierten API

Erstellen einer API Antwortaktivität

Eine Instanz einer API -Response-Aktivität wird aus der vorkonfigurierten API Verbindung erstellt mithilfe des Aktivitätstyps Antwort.

Um eine Instanz einer Aktivität zu erstellen, ziehen Sie den Aktivitätstyp auf die Design-Canvas oder kopieren Sie den Aktivitätstyp und fügen Sie ihn auf der Design-Canvas ein. Weitere Informationen finden Sie unter Erstellen einer Aktivitätsinstanz in Komponentenwiederverwendung.

Eine vorhandene API -Antwort-Aktivität kann von diesen Orten aus bearbeitet werden:

• Die Design-Canvas (siehe Aktionsmenü in Entwurfsfläche).
• Die Tab Komponenten des Projektbereichs (siehe Aktionsmenü im Projektbereich Tab Komponenten).

Konfigurieren einer API Antwortaktivität

Befolgen Sie diese Schritte, um eine API -Antwort-Aktivität zu konfigurieren:

• Schritt 1: Geben Sie einen Namen ein und legen Sie eine bevorzugte Schema fest
  Geben Sie einen Namen für die Aktivität ein und wählen Sie eine bevorzugte Schema aus.

• Schritt 2: Überprüfen Sie die Datenschemata
  Alle vom Endpoint generierten Anforderungs- oder Antwortschemata werden angezeigt.

Schritt 1: Geben Sie einen Namen ein und legen Sie eine Schema fest

Geben Sie in diesem Schritt einen Namen für die Aktivität an und wählen Sie eine Schema aus. Jedes Benutzeroberflächenelement dieses Schritts wird unten beschrieben.

• Name: Geben Sie einen Namen zur Identifizierung der Aktivität ein. Der Name muss für jede API -Antwort-Aktivität eindeutig sein und darf keine Schrägstriche enthalten / oder Doppelpunkte :.

• Anforderungsschema bereitstellen: Das Schema definiert die Struktur der Daten, die von der API -Aktivität Antwort verwendet werden. Ob ein Schema erforderlich ist, hängt davon ab, ob die API -Aktivität Antwort als Ziel einer Transformation verwendet wird (siehe Schemaverwendung). Anweisungen zum Ausfüllen dieses Abschnitts der Aktivitätskonfiguration finden Sie unter In einer Aktivität definierte Schemata.

• Speichern und beenden: Wenn aktiviert, klicken Sie hier, um die Konfiguration für diesen Schritt zu speichern und die Aktivitätskonfiguration zu schließen.

• Weiter: Klicken Sie hier, um die Konfiguration für diesen Schritt vorübergehend zu speichern und mit dem nächsten Schritt fortzufahren. Die Konfiguration wird erst gespeichert, wenn Sie im letzten Schritt auf die Schaltfläche Fertig klicken.

• Änderungen verwerfen: Klicken Sie nach dem Vornehmen von Änderungen hier, um die Konfiguration zu schließen, ohne die an einem Schritt vorgenommenen Änderungen zu speichern. Sie werden in einer Meldung aufgefordert, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Schritt 2: Überprüfen der Datenschemata

Alle vom Endpoint generierten Anforderungs- oder Antwortschemata werden angezeigt. Jedes Benutzeroberflächenelement dieses Schritts wird unten beschrieben.

• Datenschemata: Die Anfrage- und Antwortschemata für diese Aktivität werden angezeigt. Diese Datenschemata werden von benachbarten Transformations übernommen und erneut angezeigt während Transformation.

!!! note "Notiz" Die in einer Transformation bereitgestellten Daten haben Vorrang vor der Aktivitätskonfiguration.

• Plugin(s) hinzufügen: Plugins sind von Jitterbit oder vom Benutzer bereitgestellte Anwendungen, die die nativen Funktionen von Harmony erweitern. Um ein Plugin auf die Aktivität anzuwenden, klicken Sie, um diesen Abschnitt zu erweitern, und aktivieren Sie das Kontrollkästchen neben dem zu verwendenden Plugin. Weitere Anweisungen zur Verwendung von Plugins, einschließlich Details zum Festlegen aller erforderlichen Variablen, die vom Plugin verwendet werden, finden Sie unter Zu einer Aktivität hinzugefügte Plugins.

• Zurück: Klicken Sie hier, um die Konfiguration für diesen Schritt vorübergehend zu speichern und zum vorherigen Schritt zurückzukehren.

• Fertig: Klicken Sie hier, um die Konfiguration für alle Schritte zu speichern und die Aktivitätskonfiguration zu schließen.

• Änderungen verwerfen: Klicken Sie nach dem Vornehmen von Änderungen hier, um die Konfiguration zu schließen, ohne die an einem Schritt vorgenommenen Änderungen zu speichern. In einer Meldung werden Sie aufgefordert, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Nächste Schritte

Nachdem Sie eine API Response-Aktivität konfiguriert haben, können Sie sie wie unten beschrieben innerhalb einer Operation verwenden. Sobald die Operation eingerichtet ist, wählen Sie sie in der Konfiguration eines API-Manager Custom API, um die Operation oder Operation als nutzbaren REST- Endpoint verfügbar zu machen.

Schließen Sie den Operation ab

Vervollständigen Sie die Konfiguration der Operation, indem Sie weitere Aktivitäten, Transformations oder Scripts als Operation hinzufügen und konfigurieren. Sie können auch die Operation einer Operation konfigurieren, die die Möglichkeit umfassen, Operationen zu verketten, die sich im gleichen oder in unterschiedlichen Workflows befinden.

Menüaktionen für eine Aktivität sind über den Projektbereich und die Design-Canvas zugänglich. Weitere Informationen finden Sie unter Aktionsmenü in Grundlagen zu Konnektoren.

API Response-Aktivitäten können als Ziel mit diesen Operation verwendet werden:

• Archivmuster

• Script

• Transformation

• Zwei-Ziel-Archivmuster (nur als zweites Ziel)

• HTTP-Archivmuster mit zwei Zielen (nur als zweites Ziel)

• Zwei-Transformationsmuster (nur als zweites Ziel)

Ein typischer Anwendungsfall ist die mehrfache Verwendung einer API -Antwort-Aktivität innerhalb einer Operation, um unterschiedliche Fehlerantworten zu verarbeiten. Beide Operationen in diesem Beispiel verwenden das Transformationsmuster.

In diesem Beispiel wird im Operation Mitarbeiterdaten abrufen das Script Parameter validieren verwendet, um eine Eingabe für eine Datenbank-Abfrage-Aktivität (Abfrageanforderung) bereitzustellen, die eine Antwortstruktur generiert, die von der Transformation (Datenbank zu API) empfangen und von einer API Antwort-Aktivität (API-Antwort) an die Custom API zurückgegeben wird.

Bei einem Fehler bei der Operation „Mitarbeiterdaten abrufen“ wird die Operation „Fehlerantwort senden“ ausgeführt. Das Script „Fehlermeldung analysieren“ wird verwendet, um die HTTP-Fehlercodeantwort für eine benutzerdefinierte Jitterbit API mithilfe der Jitterbit-Variable zu überschreiben jitterbit.api.response.status_code und stellt die Eingabe für die Transformation Format Failure Response bereit, die dann von einer API Response-Aktivität (API Response) an die Custom API zurückgegeben wird:

Wenn Sie bereit sind, einsetzen und ausführen den Operation und validieren Sie das Verhalten durch Überprüfen der Operation.

Weitere Beispiele

Weitere Beispiele für die Verwendung von API -Aktivitäten als Ziele in einer Operation sind: Erfassen von Datenänderungen mit einer API-Manager API oder einem HTTP- Endpoint Und Konfigurieren Sie ausgehende Nachrichten mit einer API-Manager API. (Diese Muster verwenden Design Studio als Beispiel, aber die gleichen Konzepte können auch in Integration Studio.)

Konfigurieren einer benutzerdefinierten API-Manager API

Nachdem die Einrichtung des Operation abgeschlossen ist, konfigurieren Sie eine Custom API mit API-Manager.