API Anforderungsaktivität
Einführung
Eine API -Request-Aktivität unter Verwendung ihrer vorkonfigurierten API Verbindung, ruft Daten ab, wenn sie von einer benutzerdefinierten API-Manager API aufgerufen werden und soll als Quelle zur Bereitstellung von Daten für einen Operation verwendet werden.
Die API -Request-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 Request-Aktivität stattdessen.
Informationen zur Beziehung zwischen API Connector-Aktivitäten und API-Manager APIs finden Sie in diesen Ressourcen:
Erstellen einer API Anforderungsaktivität
Eine Instanz einer API -Request-Aktivität wird aus der vorkonfigurierten API Verbindung erstellt mithilfe des Aktivitätstyps Request.
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 es auf die Design-Canvas ein. Weitere Informationen finden Sie unter Erstellen einer Aktivitätsinstanz in Komponentenwiederverwendung.
Eine vorhandene API Anforderungs-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 Anforderungsaktivität
Befolgen Sie diese Schritte, um eine API -Anforderungs-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 Antwortschema - Präferenz fest
Geben Sie in diesem Schritt einen Namen für die Aktivität an und wählen Sie eine bevorzugte 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 -Anforderungs-Aktivität eindeutig sein und darf keine Schrägstriche enthalten
/
oder Doppelpunkte:
. -
Antwortschema bereitstellen: Das Schema definiert die Struktur der Daten, die von der API -Anforderungs-Aktivität verwendet werden. Ob ein Schema erforderlich ist, hängt davon ab, ob die API -Anforderungs-Aktivität als Quelle einer Transformation verwendet wird. Anweisungen zum Ausfüllen dieses Abschnitts der Aktivitätskonfiguration finden Sie unter Schemaverwendung und 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.
-
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 -Request-Aktivität konfiguriert haben, schließen Sie die Konfiguration der Operation ab, indem Sie Konfigurieren anderer Aktivitäten, Transformations oder Scripts als Operation. Sie können die Operation auch Einstellungen, darunter die Möglichkeit, Vorgänge im gleichen oder in unterschiedlichen Workflows miteinander zu verketten.
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 Request-Aktivitäten können als Quelle mit diesen Operation verwendet werden:
-
Zwei-Ziel-Archivmuster (nur als erste Quelle)
-
HTTP-Archivmuster mit zwei Zielen (nur als erste Quelle)
-
Zwei-Transformationsmuster (nur als erste Quelle)
Notiz
Vorgänge, die mit einer API Request-Aktivität beginnen, können nicht manuell ausgeführt mithilfe der Operation Bereitstellen und Ausführen oder Ausführen. Stattdessen erfordern diese Vorgänge Daten, die bereitgestellt werden, wenn ein API Aufruf mithilfe einer benutzerdefinierten API erfolgt, die über API-Manager erstellt wurde. Eine API kann von einer Anwendung aus aufgerufen werden. Wenn die API GET unterstützt, können Sie die URL auch in einen Webbrowser einfügen, um die API manuell zu nutzen.
Ein typischer Anwendungsfall ist die Verwendung einer API -Request-Aktivität und einer API -Response-Aktivität in einer Operation, wobei die erste Operation durch eine API ausgelöst wird und die zweite Operation nach dem Erfolg der ersten Operation ausgeführt wird. Beide Operationen in diesem Beispiel verwenden das Transformation.
In diesem Beispiel löst eine API die Ausführung der Operation Kundenanfrage einfügen aus. Die API -Anforderungs-Aktivität (API-Anforderung) generiert eine Antwortstruktur, die von der Transformation (API zur Datenbank) empfangen wird und dann mithilfe einer Datenbank-Einfüge-Aktivität (Antwort einfügen) in eine Datenbank eingefügt wird.
Bei erfolgreichem Abschluss der Operation Kundenanfrage einfügen wird die Operation Kundenantwort abfragen ausgeführt. Eine Datenbank-Abfrage-Aktivität (Abfrageanfrage) generiert eine Antwortstruktur, die von der Transformation (Datenbank zu API) empfangen und dann von einer API -Antwort-Aktivität (API-Antwort) an die API zurückgegeben wird:
Wenn Sie bereit sind, einsetzen und ausführen den Operation und validieren Sie das Verhalten durch Überprüfen der Operation.
Wichtig
Standardmäßig werden erfolgreiche Vorgänge, die für eine Custom API konfiguriert sind, sind nicht in den Operation enthalten, sofern nicht eine dieser Einstellungen aktiviert ist:
- Cloud-Agenten: Für API Operationen auf einem Cloud-Agenten Operation debuggen muss für die Operation aktiviert sein.
- Private Agenten: Für API Operationen auf einem privaten Agenten muss entweder Operation debuggen muss für die Operation aktiviert sein oder Sie müssen
EnableLogging=true
im[APIoperation]
Abschnitt der privaten Agentenkonfigurationsdatei.
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 mithilfe von API-Manager.
Notiz
Nachdem Sie eine Custom API zum Aufrufen konfiguriert haben an Integration Studio Operation, können Sie die Operation nicht löschen, ohne entweder die API zu löschen oder die Konfiguration der API so zu ändern, dass die Operation nicht mehr aufgerufen wird.