Einführung:
Ab Nuclos 4.0 hat der Nuclos Server einen RESTful Service integriert, der automatisch gestartet wird. Er dient primär als Interface für einen Webclient, kann aber auch grundsätzlich als Dienst verwendet werden.
Er ist unter dem Pfad "/rest/*" zu erreichen, z.B. für eine lokale Installation des Servers auf dem Port 8080:
http://localhost:8080/nuclos-war/rest/<pfad>. (z.B. für logout: http://localhost:8080/nuclos-war/rest/logout)
Session:
Jeder Teilservice außer dem Login benötigt eine Session ID. Wird keine Session ID übergeben, bzw. ist die Session ID ungültig, gibt der Service einen Fehler mit dem HTTP Status 401 (Unauthorized) zurück. Die Session ID kann entweder als Standard-Cookie oder Parameter im Http-Header beim Aufruf des REST-Services übergeben werden. Der Key muss "sessionid" lauten.
Teilservices/Pfade:
- Login (Path: /login, Method: POST, Return: String)
Erwartet ein Webformular mit den Keys "username" und "password" (und optional "locale"), authentifiziert sich damit am Nuclos-Server und gibt eine SessionID als String zurück. Die Session ID benötig wird um alle anderen Teilservices zu verwenden. Login ist der einzige Teilservice, der keine Session ID benötigt. Schlägt der Login fehl, wird ein Fehler mit dem HTTP Status 401 (Unauthorized) zurückgeworden. - Logout (Path: /logout, Method: GET)
Invalidiert die bestehende Session ID. Diese Methode gibt den HTTP Status 200 (OK), wenn die Session ID gültig war.
Überblick
Inhalte