Zum Inhalt springen

API SOAP-Anforderungsaktivität

Einführung

Eine API SOAP-Anforderungsaktivität, die ihre vorkonfigurierte API-Verbindung verwendet, ruft Daten ab, wenn sie von einer API-Manager benutzerdefinierten API aufgerufen wird, und ist dazu gedacht, als Ziel zum Konsumieren von Daten in einer Operation verwendet zu werden.

Die API SOAP-Anforderungsaktivität kann nur mit einem WSDL-Schema konfiguriert werden. Um mit einer API-Verbindung unter Verwendung eines JSON-, XML-, CSV- oder XSD-Schemas zu interagieren, verwenden Sie stattdessen eine nicht-SOAP API-Anforderungsaktivität. Um mit einer SOAP-Verbindung zu interagieren, ohne eine benutzerdefinierte API zu verwenden, nutzen Sie den SOAP-Connector.

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

Erstellen einer API SOAP-Anforderungsaktivität

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

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

Eine vorhandene API SOAP-Anforderungsaktivität kann von diesen Orten aus bearbeitet werden:

Konfigurieren einer API SOAP-Anforderungsaktivität

Befolgen Sie diese Schritte, um eine API SOAP-Anforderungsaktivität zu konfigurieren:

Schritt 1: Geben Sie einen Namen ein und spezifizieren Sie die Einstellungen

In diesem Schritt geben Sie einen Namen für die Aktivität ein und wählen die Methode aus, die zum Hochladen des WSDL-Schemas verwendet werden soll. Jedes Benutzeroberflächenelement dieses Schrittes wird im Folgenden beschrieben.

API SOAP-Anforderungsaktivitätskonfiguration Schritt 1

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

  • URL hochladen, Datei hochladen oder Vorhandenes auswählen: Verwenden Sie die Optionsschaltfläche, um die Quelle der WSDL-Datei auszuwählen, die hochgeladen oder wiederverwendet werden soll. Dateien mit einer Größe von bis zu 5 MB können hochgeladen werden.

    • URL hochladen: Geben Sie die URL der WSDL-Datei in das Textfeld ein und klicken Sie dann auf Hochladen. Die URL muss ohne Authentifizierung zugänglich sein, andernfalls erhalten Sie zur Laufzeit einen Fehler. Wenn Sie eine WSDL mit demselben Namen wie eine vorhandene WSDL hochladen, siehe Mögliche Fehler weiter unten auf dieser Seite.

    • Datei hochladen: Klicken Sie auf Durchsuchen (rechts), um lokal nach einer WSDL- oder ZIP-Datei zu suchen. Wenn Sie eine ZIP-Datei bereitstellen, muss sie eine einzelne WSDL-Datei enthalten (obwohl sie beliebige XSD-Dateien enthalten kann, von denen die WSDL abhängt). Klicken Sie dann auf Hochladen.

      Hinweis

      Jede schemaLocation muss mit einer relativen Referenz auf eine lokale Datei aufgelöst werden. Dies bedeutet in der Regel, dass anstelle der Angabe 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 bereitstellen:

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

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

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

  • Port: Verwenden Sie das Dropdown-Menü, um den entsprechenden Port auszuwählen.

  • Dienst und Bindung: Diese Felder werden standardmäßig basierend auf der bereitgestellten WSDL und dem Port automatisch ausgefüllt und können nicht bearbeitet werden.

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

  • 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 verwerfen möchten.

Schritt 2: Überprüfen der Datenschemas

Alle Anforderungs- oder Antwortschemas, die von dem Endpunkt generiert werden, werden angezeigt:

API SOAP-Anforderungsaktivitätskonfiguration Schritt 2

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

  • 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 zu speichern. Eine Nachricht fragt Sie, ob Sie die Änderungen verwerfen möchten.

Mögliche Fehler

Die folgenden Abschnitte behandeln Fehler, die während der Aktivitätskonfiguration auftreten können.

WSDL kann nicht hochgeladen werden

Wenn eine WSDL durch das erneute Hochladen einer WSDL mit demselben Namen über Upload-URL oder Datei hochladen ersetzt wird und die Operationen der Ersatz-WSDL nicht dieselben Namen wie die in den vorhandenen Aktivitäten verwendeten haben oder wenn in Verwendung befindliche WSDL-Operationen in der Ersatz-WSDL fehlen, kann dieser Fehler auftreten:

Diese WSDL kann nicht ersetzt werden, da ihr WSDL-Operationen fehlen, die von vorhandenen Aktivitäten verwendet werden. Löschen Sie diese Aktivitäten im Komponenten-Tab des Projektfensters und versuchen Sie es erneut.

Um das Problem zu lösen, stellen Sie sicher, dass die WSDL-Operationen denselben Namen haben wie die, die derzeit von vorhandenen Aktivitäten verwendet werden.

Bereitstellung fehlgeschlagen

Wenn Sie eine Operation bereitstellen, deren SOAP-Anforderungs-Aktivität WSDL-Datei ersetzt wurde, kann dieser Fehler auftreten:

Bereitstellung fehlgeschlagen - Client-Fehler: Es gibt keine hochgeladene Datei mit dem Client-Pfad ... Aktualisieren Sie auf Studio 8.4.0 oder höher und stellen Sie das Projekt erneut bereit.

Um das Problem zu lösen, befolgen Sie diese Schritte:

  1. Öffnen Sie die Aktivität, bei der die WSDL-Datei ersetzt wurde.

  2. Wählen Sie in Schritt 1 die WSDL-Datei erneut aus, die für die Aktivität verwendet werden soll, und klicken Sie dann auf Weiter.

  3. Klicken Sie in Schritt 2 auf Fertigstellen.

  4. Stellen Sie die Operation bereit.

Nächste Schritte

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

Menüaktionen für eine Aktivität sind im Projektfenster und auf der Entwurfsfläche zugänglich. Weitere Informationen finden Sie im Aktivitätsaktionsmenü in Connector-Grundlagen.

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

Wenn Sie bereit sind, setzen Sie die Operation ein und validieren Sie das Verhalten, indem Sie die Betriebsprotokolle überprüfen.

Hinweis

Operationen mit einer API SOAP-Anforderungs-Aktivität als ersten Operation Schritt 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 Integration 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.