Zum Inhalt springen

API-Antwortaktivität

Einführung

Eine API Antwort-Aktivität, die ihre vorkonfigurierte API-Verbindung verwendet, gibt Daten an eine benutzerdefinierte API des API-Managers zurück und ist dafür gedacht, als Ziel zum Konsumieren von Daten in einer Operation verwendet zu werden.

Die API Antwort-Aktivität kann mithilfe eines JSON-, XML-, CSV- oder XSD-Schemas konfiguriert werden. Um mit einer API-Verbindung unter Verwendung eines WSDL-Schemas zu interagieren, verwenden Sie stattdessen eine API SOAP-Antwortaktivität.

Für Informationen über die Beziehung zwischen API-Connector-Aktivitäten und API-Manager-APIs siehe diese Ressourcen:

Erstellen einer API-Antwortaktivität

Eine Instanz einer API Antwort-Aktivität wird aus der vorkonfigurierten API-Verbindung unter Verwendung ihres Antwort-Aktivitätstyps erstellt.

Um eine Instanz einer Aktivität zu erstellen, ziehen Sie den Aktivitätstyp auf die Entwurfsfläche oder kopieren Sie den Aktivitätstyp und fügen Sie ihn auf der Entwurfsfläche ein. Für Details siehe Erstellen einer Aktivitäts- oder Toolinstanz in Komponentenwiederverwendung.

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

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 wählen Sie eine Präferenz für das Anforderungsschema aus

In diesem Schritt geben Sie einen Namen für die Aktivität ein und wählen eine Präferenz für das Anforderungsschema aus. Jedes Benutzeroberflächenelement dieses Schrittes wird im Folgenden beschrieben.

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

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

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

  • Weiter: Klicken Sie, um die Konfiguration für diesen Schritt vorübergehend zu speichern und zum nächsten Schritt fortzufahren. Die Konfiguration wird nicht gespeichert, bis Sie die Schaltfläche Fertig im letzten Schritt klicken.

  • Änderungen verwerfen: Nach Änderungen klicken Sie, um die Konfiguration zu schließen, ohne die vorgenommenen Änderungen zu speichern. Eine Nachricht fragt Sie, ob Sie die Änderungen wirklich verwerfen möchten.

Schritt 2: Überprüfen Sie die Datenschemas

Any request or response schemas generated from the endpoint are displayed. Each user interface element of this step is described below.

  • Daten-Schemas: Die Anfrage- und Antwort-Schemas für diese Aktivität werden angezeigt. Diese Daten-Schemas werden von benachbarten Transformationen geerbt und während der Transformation-Mapping erneut angezeigt.

    Hinweis

    Daten, die in einer Transformation bereitgestellt werden, haben Vorrang vor der Aktivitätskonfiguration.

  • Plugin(s) hinzufügen: Plugins sind von Jitterbit oder Benutzern bereitgestellte Anwendungen, die die nativen Fähigkeiten von Harmony erweitern. Um ein Plugin auf die Aktivität anzuwenden, klicken Sie auf, um diesen Abschnitt zu erweitern, und wählen Sie das Kontrollkästchen neben dem zu verwendenden Plugin aus. Für zusätzliche Anweisungen zur Verwendung von Plugins, einschließlich Details zur Festlegung aller erforderlichen Variablen, die vom Plugin verwendet werden, siehe Plugins, die zu einer Aktivität hinzugefügt wurden.

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

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

  • Änderungen verwerfen: Nach Änderungen klicken Sie, um die Konfiguration zu schließen, ohne die vorgenommenen Änderungen an einem Schritt zu speichern. Eine Nachricht fragt Sie, ob Sie die Änderungen verwerfen möchten.

Nächste Schritte

Nachdem eine API Antwort-Aktivität konfiguriert wurde, vervollständigen Sie die Konfiguration der Operation, indem Sie andere Aktivitäten oder Tools als Operation-Schritte hinzufügen und konfigurieren. Sie können auch die Betriebseinstellungen konfigurieren, die die Möglichkeit umfassen, Operationen zusammenzuschalten, die sich in denselben oder unterschiedlichen Workflows befinden.

Sobald eine API Antwort-Aktivität erstellt wurde, sind die Menüaktionen für diese Aktivität im Projektbereich entweder in den Registerkarten Workflows oder Komponenten sowie auf der Design-Leinwand zugänglich. Siehe Aktivitätsaktionsmenü für Details.

API Antwort-Aktivitäten können als Ziel mit diesen Betriebsmustern verwendet werden:

Wichtig

Standardmäßig werden erfolgreiche Operationen, die für eine benutzerdefinierte API konfiguriert sind, nicht in den Betriebsprotokollen aufgeführt, es sei denn, eine dieser Einstellungen ist aktiviert:

Nicht erfolgreiche Operationen werden in den Betriebsprotokollen aufgeführt, unabhängig davon, ob die oben genannten Einstellungen aktiviert sind oder nicht.

Konfigurieren einer benutzerdefinierten API im API-Manager

Sobald die Operation konfiguriert und bereitgestellt ist, konfigurieren Sie eine benutzerdefinierte API mit API-Manager.

Hinweis

Nachdem Sie eine benutzerdefinierte API konfiguriert haben, um eine Studio-Operation aufzurufen, können Sie die Operation nicht löschen, ohne entweder die API zu löschen oder die Konfiguration der API zu ändern, sodass die Operation nicht mehr aufgerufen wird.