Seitenhistorie
| Auszug | ||
|---|---|---|
| ||
Nuclos REST Login: POST, JSON, username, password, JSESSIONID, Cookie, 401, Logout, DELETE, Session. |
Sprache: Deutsch · English
3. Login
Am REST-Service anmelden – POST mit JSON-Credentials, JSESSIONID-Cookie und Logout per DELETE.
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
| Panel | ||||
|---|---|---|---|---|
| ||||
Auf dieser Seite
|
...
|
Der Login erfolgt
...
| Codeblock |
|---|
/ |
...
per POST auf die Root-URL des REST-Service (http://localhost:8080/nuclos-war/rest/)
...
. Benutzername und Passwort werden als JSON
...
übergeben.
Request
| Codeblock |
|---|
...
|
...
| |
{"username": "nuclos", "password": ""} |
...
Erforderliche Header:
| Codeblock | |
|---|---|
|
...
| |
Accept: application/json Content-Type: application/json |
...
Die Response
...
ist ein JSON-Objekt mit den Einstiegs-Links (u.a. boMetas, menu).
Session-ID mitgeben
Alle Services (außer wenigen wie Login) benötigen eine gültige Session-ID – sonst antwortet der Service mit HTTP 401 (Unauthorized). Die Session-ID wird als Cookie JSESSIONID=xxx übergeben.
| Warnung | ||
|---|---|---|
| ||
In Nuclos 4.4.x/4.5.x war alternativ der Header |
Logout
Gleiche URL wie der Login, per DELETE – invalidiert die Session-ID (HTTP 200, wenn sie gültig war).
Verwandte Seiten
Objekt
| Codeblock | ||
|---|---|---|
| ||
{
"links": {
"boMetas": {
"href": "http://localhost:8080/nuclos-war/rest/bos",
"methods": [
"GET"
]
},
"menu": {
"href": "http://localhost:8080/nuclos-war/rest/meta/menu",
"methods": [
"GET"
]
},
"search": {
"href": "http://localhost:8080/nuclos-war/rest/data/search/{text}",
"methods": [
"GET"
]
},
"tasks": {
"href": "http://localhost:8080/nuclos-war/rest/meta/tasks",
"methods": [
"GET"
]
}
},
"locale": "en_US",
"sessionId": "07886B9397400D168EF2B49DBDB3F913",
"username": "nuclos"
} |
Mitgabe der Session ID
Jeder Service, bis auf wenige Ausnahmen (z.B. 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 als Http-Header-Parameter beim Aufruf des REST-Services übergeben werden. Der Key lautet "Cookie" und der Inhalt muss dem Schema "JSESSIONID=xxx" entsprechen, wobei xxx durch die aktuelle Session ID ersetzt werden muss.
| Info |
|---|
In den Nuclos Versionen 4.4.x und 4.5.x kann alternativ auch der Http-Header-Parameter "sessionId" verwendet werden, was allerdings ab Version 4.6 NICHT mehr möglich ist. |
Logout
Die URL ist identisch zum Login. Per DELETE invalidiert man die bestehende Session ID. Dieser Service gibt den HTTP Status 200 (OK) zurück, wenn die Session ID gültig war.
Ausführbares Beispiel
Siehe Beispielaufrufe per Shell
Überblick
Inhalte