Anbindungen - Webservice Erreichbarkeitsprüfung

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

Webservice Erreichbarkeitsprüfung

zuletzt bearbeitet von Form-Solutions GmbH

am 05.04.2024

Inhaltsverzeichnis

Wo wird die Webservice Erreichbarkeitsprüfung eingesetzt?

Wie funktioniert die Erreichbarkeitsprüfung?

Wo wird die Webservice Erreichbarkeitsprüfung eingesetzt?

Bei der Einrichtung eines Webservice in der Mandanten-Modulkonfiguration durch die "Prüfen"-Schaltfläche. Die Einrichtung findet sich unter Web Services - WebService Konfiguration.

Beim Assistentenstart wird die Erreichbarkeit des Webservices unter der in der Modulkonfiguration hinterlegten URL geprüft. Dabei werden sowohl die Webservice-Komponente, als auch die WebService-Anfrage während der Einreichung berücksichtigt.

Wie funktioniert die Erreichbarkeitsprüfung?

Als Endpunkt für die Erreichbarkeitsprüfung dient die in der Modulkonfiguration (siehe oben) hinterlegte "WebService-Url".

Es wird versucht eine Verbindung zu dieser URL aufzubauen. Dazu wird eine Reihe von HTTP-Requests an die URL geschickt, von denen mindestens einer eine "positive" Antwort erhalten muss, um die Erreichbarkeitsprüfung erfolgreich zu bestehen.

Eine "positive" Antwort gilt als gegeben, wenn ein HTTP-Status-Code vom Server empfangen werden konnte und dieser nicht der 5xx-Serie (Server-Fehler) angehört und auch nicht einem der Client-Error Codes 401, 403 oder 404 entspricht.

Die nachfolgenden HTTP-Requests werden nach einander gesendet, es sei denn es wird vorher eine positive Antwort empfangen oder der HTTP-Status-Code der Antwort kann nicht ermittelt werden:

HEAD-Request an die URL

GET-Request an die URL

GET-Request an die URL mit angehängtem Query-Parameter "wsdl"

Beispiel 1: https://ws.form-solutions.test?wsdl

Beispiel 2: https://ws.form-solutions.test?param=1&wsdl

Jeder der gesendeten Requests sendet den Header "Accept" mit dem Wert "*/*" (wodurch signalisiert wird, dass jede Art von Daten bzw. auch keine Daten im Response-Body akzeptiert werden).

Sind in der Modulkonfiguration neben der URL auch Authentisierungsdaten (HTTP-Basic und/oder Zertifikats-Key-/Truststore) hinterlegt, so werden diese ebenfalls mit den oben genannten Requests mitgesendet.

Falls beim Start eines Assistenten durch den Bürger keine der beschriebenen Prüfungen erfolgreich war, wird statt des Assistenten eine Seite ähnlich der folgenden angezeigt: