API SOAP Antwortaktivität

Einführung

Eine API SOAP Response-Aktivität, die ihre vorkonfigurierte API Verbindung verwendet, 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 Aktivität SOAP Antwort kann nur mit einem WSDL Schema konfiguriert werden. Um mit einer API Verbindung über ein JSON-, XML-, CSV- oder XSD Schema zu interagieren, verwenden Sie eine Nicht-SOAP Aktivität API Antwort stattdessen. Um mit einer SOAP -Verbindung zu interagieren, ohne eine Custom API zu verwenden, verwenden Sie den SOAP Connector.

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 SOAP Antwortaktivität

Eine Instanz einer API SOAP Response-Aktivität wird aus der vorkonfigurierten API -Verbindung erstellt mithilfe des Aktivitätstyps SOAP 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 SOAP 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 SOAP Antwortaktivität

Führen Sie die folgenden Schritte aus, um eine API Aktivität SOAP Antwort zu konfigurieren:

• Schritt 1: Geben Sie einen Namen ein und legen Sie die Einstellungen fest
  Geben Sie einen Namen für die Aktivität ein und wählen Sie die Methode aus, die zum Hochladen des WSDL Schema verwendet werden soll.
• Schritt 2: Überprüfen Sie die Datenschemata
  Alle vom Endpoint generierten Anforderungs- oder Antwortschemata werden angezeigt.

Schritt 1: Namen eingeben und Einstellungen festlegen

Geben Sie in diesem Schritt einen Namen für die Aktivität an und wählen Sie die Methode aus, die zum Hochladen des WSDL Schema verwendet werden soll. 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 SOAP Response-Aktivität eindeutig sein und darf keine Schrägstriche enthalten / oder Doppelpunkte :.

• URL hochladen, Datei hochladen oder Vorhandenes auswählen: Verwenden Sie das Optionsfeld, um die Quelle der WSDL-Datei (Web Services Description Language) zum Hochladen oder Wiederverwenden auszuwählen. Es können Dateien mit einer Größe von bis zu 5 MB hochgeladen werden.

  • URL hochladen: Geben Sie die URL der WSDL-Datei in das Textfeld ein und klicken Sie dann auf die Schaltfläche Hochladen. Die URL muss ohne Authentifizierung zugänglich sein, sonst erhalten Sie eine Fehlermeldung. Wenn Sie eine WSDL mit demselben Namen wie eine vorhandene WSDL hochladen, lesen Sie Ersetzen einer hochgeladenen WSDL weiter unten auf dieser Seite.

  • Datei hochladen: Verwenden Sie die Schaltfläche Durchsuchen rechts, um lokal zu einer WSDL- oder ZIP-Datei zu navigieren. Wenn Sie eine ZIP-Datei bereitstellen, muss diese eine einzelne WSDL-Datei enthalten, sie kann jedoch auch alle XSD-Dateien enthalten, von denen die WSDL abhängig ist. Klicken Sie dann auf die Schaltfläche Hochladen. Wenn Sie eine WSDL mit demselben Namen wie eine vorhandene WSDL hochladen, lesen Sie Ersetzen einer hochgeladenen WSDL weiter unten auf dieser Seite.

    Hinweis

    Beliebig schemaLocation muss mithilfe einer relativen Referenz in eine lokale Datei aufgelöst werden. Dies bedeutet normalerweise, dass anstelle der Bereitstellung eines Tupels wie:

    xsi:schemaLocation='http://schemas.xmlsoap.org/wsdl/mime/ http://ws-i.org/profiles/basic/1.1/wsdlmime-2004-08-24.xsd'

    Sie würden angeben:

    xsi:schemaLocation='http://schemas.xmlsoap.org/wsdl/mime/ wsdlmime-2004-08-24.xsd'

    Im obigen Beispiel die XSD-Datei wsdlmime-2004-08-24.xsd befindet sich entweder im selben Verzeichnis oder auf einem Pfad relativ zum geladenen WSDL.

• Vorhandenes auswählen: Verwenden Sie die Dropdown-Liste, um eine vorhandene WSDL-Datei auszuwählen, die zuvor im aktuellen Projekt verwendet wurde.

• Port: Verwenden Sie die Dropdown-Liste, um den entsprechenden Port auszuwählen.

• Dienst und Bindung: Standardmäßig werden diese Felder automatisch auf Grundlage der bereitgestellten WSDL und des Port ausgefüllt und können nicht bearbeitet werden.

• Operation: Verwenden Sie die Dropdown-Liste, um die Methode aus der bereitgestellten WSDL auszuwählen, die Sie mit dieser Aktivität ausführen möchten.

• Speichern und beenden: Wenn aktiviert, klicken Sie, 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 hierauf, 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:

• 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.

  Notiz

  Die in einer Transformation bereitgestellten Daten haben Vorrang vor der Aktivitätskonfiguration.

• 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, 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 hierauf, 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.

Ersetzen einer hochgeladenen WSDL

Wenn Sie eine WSDL ersetzen, indem Sie eine WSDL mit demselben Namen erneut hochladen, indem Sie URL hochladen oder Datei hochladen, müssen die WSDL-Operationen dieselben Namen haben wie die WSDL-Operationen, die derzeit von vorhandenen Aktivitäten verwendet werden. Wenn sie nicht dieselben Namen haben oder wenn verwendete WSDL-Operationen in der Ersatz-WSDL fehlen, werden Sie in einer Fehlermeldung aufgefordert, diese Aktivitäten zuerst zu löschen:

Wenn die oben beschriebenen WSDL-Ersetzungskriterien erfüllt sind, werden in einer Bestätigungsmeldung die Aktivitäten aufgelistet, die durch die Ersetzung der WSDL betroffen sein können, und es wird vorgeschlagen, benachbarte Transformations auf mögliche Zuordnungsfehler zu überprüfen. Wenn Sie auf Weiter klicken, wird die WSDL an allen Stellen im gesamten Projekt ersetzt, an denen sie verwendet wird:

Nächste Schritte

Nachdem Sie eine API SOAP 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 SOAP Response Aktivitäten können als Ziel mit diesen verwendet werden Operation:

• 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 SOAP Antwortaktivität innerhalb einer Operation, um unterschiedliche Fehlerantworten zu verarbeiten. Beide Operationen in diesem Beispiel verwenden das Transformationsmuster.

In diesem Beispiel wird in der Operation Kreditkartendaten 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 SOAP) empfangen und von einer API SOAP Antwort-Aktivität (API SOAP Antwort) an die API zurückgegeben wird.

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

Um die Aktivität mit Skriptfunktionen zu verwenden, schreiben Sie die Daten an einen temporären Speicherort und verwenden Sie dann diesen temporären Speicherort in der Skriptfunktion.

Wenn Sie bereit sind, einsetzen und ausführen Die 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.