moveIT WebServices

Erklärung moveIT WebServices (Service Broker)

moveIT WebServices sind Schnittstellen, die es Fremdsystemen ermöglichen, in Echtzeit mit moveIT Systemen über das Netzwerk/Internet zu kommunizieren. Je nach WebService können Daten in Echtzeit übertragen und/oder abgefragt werden.

moveIT WebServices bieten somit eine flexible und leistungsfähige Lösung für die Integration von moveIT Systemen in verschiedene Geschäftsszenarien und können damit dazu beitragen, Prozesse weiter zu digitalisieren und zu optimieren.

Der Service Broker an sich stellt dabei die Basis für die moveIT WebServices dar. Der Service Broker nimmt Anfragen an den WebService entgegen und leitet diese zur Verarbeitung weiter. Der Service Broker ist dabei in sich ein WebServer, basierend auf .NET OWIN/Katana und speziell optimiert und abgesichert auf die Bedürfnisse für moveIT WebServices. Der Service Broker wird dabei auf eine bestehendes moveIT System aufgesetzt.

Mögliche WebServices:

• moveIT Bestellkommunikation

• Bestellfreigabe aus ERP System

• moveIT WEBCON Bestellprozess

• etc.

Einrichtung

Die Einrichtung des Service Brokers erfolgt soweit als möglich durch die Firma moveIT. Um aber eine Erreichbarkeit über das Internet zu schaffen, müssen Arbeiten durchgeführt werden, die nur vom Service Provider, also dem Betreiber/Inhaber der umliegenden Serverinfrastruktur und Domain, durchgeführt werden können.

Dazu ist es initial notwendig, dass gemeinsam eine netzwerktechnische Positionierung des Service Brokers besprochen wird. Hier gibt es mehrere Möglichkeiten, die je nach Kunde und bestehenden Möglichkeiten und Policies unterschiedlich sind.

Je nach Positionierung und technischen Gegebenheiten ist es notwendig, dass vom Inhaber der Domain ein öffentlicher DNS-Eintrag mit der vorhandenen Domain erstellt wird – z.B. moveitwebservice.domain.com. Dieser Eintrag muss auf die IP-Adresse des definierten Endpoint verweisen, der den Request nun entgegennimmt (z.B. Externe-Firewall, API-Gateway wenn vorhanden).

Weiters ist es notwendig, dass der Inhaber der Server-/Netzwerk-Infrastruktur die externe Firewall bzw. das API-Gateway (wenn vorhanden) nun so konfiguriert, dass der Request an den definierten Server weiterleitet, auf dem der moveIT WebService eingerichtet wurde.

Dieser Server muss ein supportetes Windows Server Betriebssystem installiert haben (Systemanforderungen). Dabei läuft der Service Broker permanent auf dem definierten Server als Prozess und wird so konfiguriert, dass dieser bei Systemneustart auch automatisch gestartet wird. Die Konfiguration dafür erfolgt über die Windows Aufgabenplanung.

Der moveIT Service Broker läuft dort auf einem gemeinsam definierten Port (z.B. 8484). Die gesendeten Requests müssen an diesem Endpoint ankommen und werden dort verarbeitet.

Technischer Aufbau

Betrieb, Sicherheit und Überwachung des Service Brokers

Sicherheit

Da eine HTTPS Kommunikation angeraten wird, muss an einer Stelle ein Zertifikathandling eingerichtet werden. Dies passiert üblicherweise durch den Service Provider auf der Firewall bzw. am API-Gateway (wenn vorhanden). Eine andere Möglichkeit wäre auch, dass auf dem Endpoint, auf dem der Service Broker läuft, ein anderer WebServer installiert wird und als Reverse Proxy konfiguriert wird und dieser das Zertifikathandling übernimmt. In diesem Fall ist ein passendes Zertifikats vom Domain-Inhaber/Service Provider auf dem Server bereitzustellen – die Einrichtung eines solchen WebServers kann durch moveIT in Dienstleistung erfolgen (mit dem Projektmanager abstimmen). In diesem Fall ist es auch notwendig, dass der Betreiber vor Ablauf eines Zertifikates dies selbst tauscht oder aktiv auf moveIT zukommt, um das neue Zertifikat zu hinterlegen.

Die restliche Security-Konfiguration von Firewall, API-Gateway (wenn vorhanden) und Netzwerk obliegt dem Service-Provider, da nur dieser Kenntnis und Zugriff über den Netzwerkaufbau hat. Sehen Sie dazu unbedingt Sicherheitsstrategien für moveIT Web-Applikationen

Monitoring

Der Service Broker bzw. der integrierte Web-Server kann mittels Health-Check Requests durch z.B. ein vorhandenes Monitoring zyklisch abgefragt werden. Dabei kann der definierten Endpoint URL der Parameter „?CheckStatus“ mitgegeben werden. Z.B. auch mit CURL

curl -X POST https://api.domain.com/service/index.html?CheckStatus -i

Für Tools wie z.B. Uptrends Monitoring kann folgender HTTP Request Header per POST gesendet werden:

Host: api.domain.com
Accept: /­­

Ist alles OK, so wird der HTTP Statuscode 200 zurück geliefert und man kann sichergehen, dass der Broker läuft. Zusätzlich kommt noch als Antwort ein JSON mit dem Inhalt {„Success“:true} zurück.

Ist der Broker gestoppt oder läuft aus einem Fehlergrund nicht, so kommt 503 zurück. Zusätzlich kommt noch als Antwort das JSON {„Success“:false} zurück.

Programmupdate

Da der Service Broker Teil des betriebenen moveIT Systems ist, ist dieser auch im Falle eines Programmupdates zu betrachten.

Wird ein Programmupdate (bei Stammdatenupdate NICHT notwendig) durchgeführt, so muss der Service Broker zuvor beendet werden und nach dem Programmupdate wieder gestartet werden.

In diesem Zeitraum nimmt der Broker keine Requests an – deshalb ist es zu empfehlen, diese Updates außerhalb der üblichen Dienstzeiten bzw. in (angekündigten) Wartungsfenstern durchzuführen.

Checkliste

Nachfolgend eine Checkliste mit Zuordnung nach ausführender Partei.

Vorbereitung

• Initiale Abstimmung über die Positionierung des Service Brokers im Netzwerk [Service Provider (oder IT Partner des Service Providers) / moveIT]

• Vorbereitung des Servers auf dem der Service Broker laufen soll und der Firewall-/Netzwerk-Einstellungen [Service Provider (oder IT Partner des Service Providers)]

• Info über endgültige URL an moveIT [Service Provider (oder IT Partner des Service Providers)]

• Optional aber empfohlen: SSL-Zertifikat für Endpoint erstellen und hinterlegen [Service Provider (oder IT Partner des Service Providers) / moveIT]

Ausführung und Installation

• Einrichtung eines DNS-Eintrags für Service Broker Endpoint [Service Provider (oder IT Partner des Service Providers)]

• Einrichtung des Service Brokers auf dem definierten Server [Service Provider (oder IT Partner des Service Providers) / moveIT]

• Funktionstest des Service Brokers per WebService Test [Service Provider (oder IT Partner des Service Providers) / moveIT]

• Sichere Hinterlegung der URL im moveIT Code [moveIT]

• Optional aber empfohlen: Einrichtung eines separaten WebServers als Reverse Proxy [in Abstimmung mit moveIT]

• Optional aber empfohlen: Einrichtung eines Monitorings [Service Provider (oder IT Partner des Service Providers)]

Laufende und wiederkehrende Aufgaben

• Optional aber empfohlen: Fixen Patching Prozess definieren [Service Provider (oder IT Partner des Service Providers)]

• Optional aber empfohlen: Reminder für Zertifikatablauf und erneuter Hinterlegung setzen [Service Provider (oder IT Partner des Service Providers)