Zum Inhalt springen

API-Anforderungsaktivität

Einführung

Eine API Anforderungsaktivität, die ihre vorkonfigurierte API-Verbindung verwendet, ruft Daten ab, wenn sie von einer benutzerdefinierten API des API-Managers aufgerufen wird, und soll als Quelle dienen, um Daten für eine Operation bereitzustellen.

Die API Anforderungsaktivitä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-Anforderungsaktivität.

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

Erstellen einer API-Anforderungsaktivität

Eine Instanz einer API Anforderungsaktivität wird aus der vorkonfigurierten API-Verbindung unter Verwendung ihres Anforderungsaktivitä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 Anforderungsaktivität kann von diesen Orten aus bearbeitet werden:

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 wählen Sie eine Antwortschemaspräferenz aus

In diesem Schritt geben Sie einen Namen für die Aktivität ein und wählen eine Antwortschemaspräferenz 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 Anforderungs-Aktivität eindeutig sein und darf keine Schrägstriche / oder Doppelpunkte : enthalten.

  • Antwortschema bereitstellen: Das Antwortschema 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. 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 fordert Sie auf, zu bestätigen, dass Sie die Änderungen 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 Transformationszuordnung erneut angezeigt.

  • Plugin(s) hinzufügen: Plugins sind von Jitterbit oder vom Benutzer 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 Vornehmen von Änderungen klicken Sie, um die Konfiguration zu schließen, ohne die an einem Schritt vorgenommenen Änderungen zu speichern. Eine Nachricht fragt Sie, ob Sie die Änderungen wirklich verwerfen möchten.

Nächste Schritte

Nachdem Sie eine API Anfrage-Aktivität konfiguriert haben, vervollständigen Sie die Konfiguration des Vorgangs, indem Sie andere Aktivitäten oder Werkzeuge als Vorgangsschritte hinzufügen und konfigurieren. Sie können auch die Betriebseinstellungen konfigurieren, die die Möglichkeit umfassen, Vorgänge zusammenzuschalten, die sich in denselben oder unterschiedlichen Workflows befinden.

Sobald eine API Anfrage-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 Entwurfskanvas zugänglich. Siehe Aktivitätsaktionsmenü für Details.

API Anfrage-Aktivitäten können als Quelle mit diesen Vorgangsmustern verwendet werden:

Hinweis

Operationen, die mit einer API Anfrage-Aktivität beginnen, können nicht manuell ausgeführt werden, indem die Optionen Bereitstellen und Ausführen oder Ausführen verwendet werden. Stattdessen erfordern diese Operationen Daten, die bereitgestellt werden, wenn ein API-Aufruf über eine benutzerdefinierte API erfolgt, die über API Manager erstellt wurde. Eine API kann von einer Anwendung aufgerufen werden oder — wenn die API GET unterstützt — können Sie die URL in einen Webbrowser einfügen, um die API manuell zu konsumieren.

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.