SimbaERP Online

ERP Rest Service

Im ERP lässt sich ein Rest-Server starten und betreiben. Mittels dieses Rest-Service können (beliebige) NXPs als Funktionen für den Rest-Service zur Verfügung gestellt werden.

Im Applicationverzeichnis des ERP-Mandanten befindet sich unter "System\Server_service" die "SimbaRestService.nxp". Durch Aufruf dieser NXP wird der Rest-Server gestartet. Beim ersten Start prüft das System, ob entsprechende Rechte zur ausführen auf dem verwendeten Port 40 auf dem lokalen System verfügbar sind. Wenn nicht, erhält der User einen Befehl für die Kommandozeile (ausführen als Admin), um die entsprechende Nutzung des Ports zu ermöglichen.

Die für den Rest-Service verwendeten NXPs werden im Applicationverzeichnis des Mandanten unter "_RestService" abgelegt und von dort vom Rest-Server geladen.

Ein Aufruf des Rest-Service sieht für einen lokal laufenden Rest-Service folgendermaßen aus: http://localhost:40/RestService/offerCreation.nxMacro.GetOffer?OrderNr=4
Der Aufbau sieht folgendermaßen aus

Aufruf des Serversfester Aufruf des RestServiceName der NXPName der Klasse innerhalb der NXPName der aufzurufenden Funktion in der NXPParameter
http://localhost:40/RestService/offerCreation.nxMacro.GetOffer?OrderNr=4

Aktuell (Stand August 2022) können über den Rest-Service nur Get-Anfragen verarbeitet werden. Post-Anfragen werden automatisch in GET-Anfragen umgewandelt. Für die Zukunft wäre es denkbar, auch POST-Anfrage komplett zu unterstützen. Bis dahin muss die Übergabe von komplexen Datenstrukturen beim Aufruf des Rest-Service über die Möglichkeiten von GET-Aufrufen realisiert werden.

Zur Rückgabe von Informationen aus dem Service erzeugt man in der Klasse entsprechende Funktionen. Die Umwandlung der Rückgabewerte in JSON übernimmt komplett der Rest-Service. Es werden automatisch "sämtliche" Typen von Informationen in JSON-Representationen umgewandelt, also neben einfachen Datentypen auch z. B. DataTables und ganze Objekte/Klasse (solange die serialisierbar sind).

Bei Aufruf des Rest-Service verlangt dieser eine Basic-Authentification. Es wird ein Benutzername und Passwort verlangt. Innerhalb der Klasse im Rest-Service kann man sich die Informationen zum angegebenen Benutzernamen, Passwort und der Absender-IP als Variablen injezieren lassen. Dafür müssen nur in der Klasse folgende Public-Variablen angelegt werden

Innerhalb des Rest-Service bzw. den angebotenen Funktionen muss man sich selbst um die entsprechenden Authentifiizerung kümmern. Man könnte zum Beispiel auch Session-Tokens ausgeben und bei jedem Aufruf verlangen.