Webservice - Webservice einrichten

Page / - zuletzt bearbeitet von Form-Solutions GmbH am 15.02.2024

Webservice einrichten

zuletzt bearbeitet von Form-Solutions GmbH

am 15.02.2024

Inhaltsverzeichnis

Webservice Definition

Webservice Konfiguration

Konfigurationsoptionen

Queue-Messaging

WebService Aktionen

WebService SOAP-Header

WebService-HeaderParameter

Webservice Definition

In der Rubrik „Webservice Definition“ können neue Webservices hinzugefügt bzw. bearbeitet werden. Je nachdem welche Einstellungen der Mandant des Benutzers enthält, stehen bereits Verlagswebservices zur Verfügung.

Über den vorgezeigten Beispielservice „iKfz“ können beispielsweise Fahrzeugdaten an das Kraftfahrtbundesamt übermittelt und von dort empfangen werden.

Neue Webservices können über die Schaltfläche „Hinzufügen“ in der Übersicht angelegt werden. In der nachfolgenden Eingabemaske müssen ein „Name“ sowie eine „Version“ für den neuen Webservice eingetragen werden. In dem Uploadfeld „Webservicearchiv“ kann die XML-Datei (Zipdatei) hochgeladen werden.

Webservice Konfiguration

Unter der Rubrik „Webservice-Konfiguration“ können die angelegten Webservices definiert werden. Hierzu muss über die Dropdownkomponenten der zu bearbeitende Webservice ausgewählt werden. Es gibt bei der WebService Konfiguration nur ein benötigtes Feld, alle weiteren sind optional. Bei näher gehenden Fragen zur Konfiguration wenden Sie sich bitte an unseren Support.

Konfigurationsoptionen

WebService-Url

Hier muss die vollständige URL angegeben werden unter die der WebService zu erreichen ist.

Mit der Schaltfläche "Prüfen" kann ein einfacher Test mit der URL ausgeführt werden. Details zur Erreichbarkeitsprüfung

Wenn das Kontrollkästchen "Daten per Queue-Messaging übertragen" aktiviert worden ist, wird die Schaltfläche "Prüfen" nicht verfügbar sein.

SOAP-Version

Hier kann die SOAP Version hinterlegt werden.

Transportmodus für die Anfrage

Bei Auswahl der Option "MTOM" wird die SOAP-Nachricht mit Transportoptimierung gesendet. Dieser Mechanismus ist für die Übertragung von Binärdaten empfohlen. Die Option "SOAP" ist gleichbedeutend mit dem Direktversand.

Werte für HTTP-Basic Authentifikation

Die hier angegebenen Werte sind optional, allerdings nur dann, wenn beide Felder frei bleiben.

Als Benutzername muss der nicht-kodierte Benutzername angegeben werden, mit dem der Aufruf authentifiziert werden soll.
Als Passwort muss das nicht-kodierte Passwort für den angegebenen Benutzernamen eingetragen werden.

Form-Solutions kann nicht überprüfen, ob diese Form der Authentifikation für den aufzurufenden WebService benötigt wird oder nicht, daher wird es keine Validierungsfehler geben, wenn Benutzername und Password für die Kommunikation benötigt werden, aber nicht angegeben wurden. Weiterhin kann Form-Solutions nicht die Korrektheit von Benutzername und Passwort feststellen.

Werte für Zertifikatsauthentifizierung

Die hier angegebenen Werte sind optional, allerdings nur dann, wenn beide Felder frei bleiben.

Als KeyStore Datei wird ein gültiger Java-KeyStore erwartet, der ein Client- und ein Server-Zertifikat beinhaltet, um sich am Server des Webservice zu authentifizieren. Beim hochladen darf die WSDL und ZIP nicht in einer Datei sein. Das Passwort, welches angegeben wird, muss für den übergebenen Client-Schlüssel und die KeyStore-Datei gleich sein, da ansonsten der Schlüssel nicht entsperrt werden kann.

Informationen zur Erstellung eines entsprechenden KeyStores entnehmen Sie bitte der Administrationsdokumentation.

Queue-Messaging

Wenn das Kontrollkästchen "Daten per Queue-Messaging übertragen" aktiviert wird, wird die Oberfläche um fünf neue Felder erweitert. In diesen werden die für die Queue-Kommunikation notwendigen Konfigurationsparameter hinterlegt. Diese Einstellungen sollten nur nach Absprache mit Form-Solutions gesetzt werden, da diese Art der Kommunikation mit WebServices sehr speziell ist.

WebService Aktionen

Sollen unabhängig vom Assistenteninhalt statische Werte beim Webservice-Aufruf übergebenen werden, so kann man diese unter "WebService Aktionen" hinterlegen. Dabei muss darauf geachtet werden, dass als Parametername ein vollqualifizierter XML-Pfad anzugeben ist.

Bsp.: {http://webservice.interfaces.formsolutions.de/}writeXMLData.{http://webservice.interfaces.formsolutions.de/}xml*.{http://www.destatis.de/schema/datml-raw/2.0/de}DatML-RAW-D*.{http://www.destatis.de/schema/datml-raw/2.0/de}nachricht*.{http://www.destatis.de/schema/datml-raw/2.0/de}GemeindeName*

Die Notation entspricht derjenigen im Fieldmapping zuzüglich der Namespaces.

WebService SOAP-Header

Benötigt der angesprochene Webservice spezielle SOAP-Header zur Verarbeitung, so kann hier ein kompletter XML-Block hinterlegt werden, der zur Ausführung in die entsprechende SOAP-Nachricht innerhalb des Header-Tags eingefügt wird. Dadurch lassen sich auch komplexere XML-Strukturen übergeben.

Bei der Eingabe des Soap-Headers ist folgendes zu beachten:

Die "Klammern" des Headers sollen nicht mit eingetragen werden.

Ein Beispiel eines gültigen Eintrags (hier für WSSE-Security-Einstellungen) wäre:

WebService-HeaderParameter

Um zusätzliche HTTP-Header beim Aufruf zu übergeben (z.B. zur Authentifizierung), können diese als Name-/Wertpaare unter dem Punkt "WebService-HeaderParameter" hinterlegt werden. Zu beachten ist dabei, dass diese unabhängig von der aufgerufenen Aktion übergeben werden.