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 dazu 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:

Hinweis

Wenn der Endpunkt eine spezifische Zeichencodierung für die Antwortdaten oder einen bestimmten Antwortinhaltstyp erfordert, setzen Sie jitterbit.target.text.character_encoding oder jitterbit.api.response.headers.content_type in einem Skript vor jeglicher Transformation in der Operation. Zum Beispiel verwenden Sie jitterbit.api.response.headers.content_type = "text/html; charset=utf-8", um den Inhaltstyp anzugeben.

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 Entwurfsgrafik oder kopieren Sie den Aktivitätstyp und fügen Sie ihn auf der Entwurfsgrafik ein. Für Details siehe Erstellen einer Aktivitäts- oder Toolinstanz in Komponentenwiederverwendung.

Ein vorhandenes API Response-Aktivität kann von diesen Orten aus bearbeitet werden:

Konfigurieren einer API Response-Aktivität

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

Schritt 1: Geben Sie einen Namen ein und wählen Sie eine Anfrage-Schema-Präferenz aus

In diesem Schritt geben Sie einen Namen für die Aktivität ein und wählen eine Anfrage-Schema-Präferenz aus. Jedes Benutzeroberflächenelement dieses Schrittes wird unten beschrieben.

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

  • Anfrage-Schema bereitstellen: Das Anfrage-Schema definiert die Struktur der Daten, die von der API Response-Aktivität verwendet werden. Ob ein Schema erforderlich ist, hängt davon ab, ob die API Response-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.

  • Nächster Schritt: 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 dem Ändern klicken Sie, um die Konfiguration zu schließen, ohne die Änderungen an einem Schritt zu speichern. Eine Nachricht fordert Sie auf, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Schritt 2: Überprüfen der Datenschemas

Alle Anforderungs- oder Antwortschemas, die von dem Endpunkt generiert wurden, werden angezeigt. Jedes Benutzeroberflächenelement dieses Schrittes wird im Folgenden beschrieben.

  • Datenschemas: Die Anforderungs- und Antwortschemas für diese Aktivität werden angezeigt. Diese Datenschemas werden von angrenzenden Transformationen geerbt und während der Transformationszuordnung 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, 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 dem Ändern klicken Sie, um die Konfiguration zu schließen, ohne die Änderungen an einem Schritt zu speichern. Eine Nachricht fordert Sie auf, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Nächste Schritte

Nachdem Sie eine API Antwort-Aktivität konfiguriert haben, 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, die sich in denselben oder unterschiedlichen Workflows befinden, miteinander zu verknüpfen.

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

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

Wichtig

Vorgänge, die von einem API-Manager benutzerdefinierten API ausgelöst werden, verfügen über zusätzliche Protokollierungsoptionen, die aktiviert werden können. Für Details darüber, was in den Betriebsprotokollen erscheint und wie zusätzliche Protokollierung aktiviert werden kann, siehe API-Anforderungs- und Antwortdaten in Betriebsprotokollen.

Konfigurieren einer benutzerdefinierten API im API-Manager

Sobald der Vorgang konfiguriert und bereitgestellt ist, konfigurieren Sie eine benutzerdefinierte API mit API-Manager.

Hinweis

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