REST-API mit Webserver

REST-API mit integriertem Web Server

ATPDesigner stellt einen Webservice mit Diensten zur Netzberechnung (Services) zur Verfügung, die über Internet oder Intranet mit Hilfe eines REST-API genutzt werden können. Zur Realisierung des Webservice ist in ATPDesigner ein Webserver integriert.

"Ein Webserver ist die Kernkomponente jedes Webangebotes, er nimmt Anfragen der Clients entgegen und liefert die entsprechenden Inhalte zurück. Die Daten werden in der Regel über das Hypertext Transfer Protocol (HTTP) oder dessen mit Transport Layer Security (TLS) verschlüsselte Variante http Secure (HTTPS) transportiert. Da Webserver eine einfache Schnittstelle zwischen Serveranwendungen und Benutzern bieten, werden sie auch häufig für interne Informationen und Anwendungen in Institutionsnetzen, wie dem Intranet, eingesetzt."(Quelle: www.bsi.bund.de)

Mit Hilfe eines REST-API kann der in ATPDesigner integrierte Webserver durch einen Webclient gesteuert und es können Daten ausgetauscht werden. Als Webservice können mit Hilfe des REST-API von einem Webclient durch eine Anfrage (Request) Verarbeitungsprozesse (Task) gestartet oder vorhandene Daten angefragt und an den Webclient als Response versendet werden. Die Kommunikation zwischen Webserver und Webclient verwendet das http-Protokoll. Semantik und Syntax des REST-API des in ATPDesigner integrierten Webservers verwenden die grundlegenden Komponenten des http-Protokolls. 

ATPDesigner ermöglicht es, ausgewählte Funktionen des Netzberechnungsprogramms im Sinne einer Client-Server-Architektur auszuführen. Durch das REST-API ist der Ablauf des Datenaustausches zwischen dem Webclient und dem integrierten Webserver definiert. Der Datenaustausch zwischen Webclient und Webserver sieht vor, dass der Webclient eine Anfrage (Request) an den Webserver stellt. Der Webserver wertet die Anfrage aus und liefert eine Antwort (Response) an den Webclient, die falls möglich die angefragten Daten als Inhalt (Content) enthält.

ATPDesigner nutzt zur Realisierung des Webservice einen http-basierten Webserver, der über ein TCP/IP-basiertes Netzwerk mit Webclients kommunizieren kann. Daher muss dem in ATPDesigner integrierten Webserver eine IP-Adresse und ein Port zugewiesen werden. Die Einstellung des Webservers erfolgt im Einstelldialog Programmeinstellungen, Registerkarte Webserver. Als Sicherheitsmechanismus unterstützt ATPDesigner die Verwendung einer Whitelist.

ATPDesigner WebServer