...
User sessions can be created / deleted by this API. Also some status information to the authenticated user can be retrieved.
URL: | /editor/session/[SESSION_ID] |
Available Methods: | GET/POST/DELETE |
Specialities: | See below |
POST Request
The POST requests needs the following two parameters either as data object or plain form parameters:
Name | Type | Info |
login | string | The user to be authenticated. |
passwd | string | The passwd of the user to be authenticated. |
| taskGuid | string | Optional: The taskGuid of the task which should be opened for the user. |
POST resulting resource layout
...
A successful result looks like:
Name | Type | Info |
sessionId | string | the sessionId of the newly created session, can be used directly for further API communication. The given sessionId is essential for further usage of other requests to the API, see below in the section API Usage. |
sessionToken | string | A one time usable token which can be passed to the users browser for overtaking the created session. For example: Users are administered by your software, translate5 is just embedded. |
GET resulting resource layout
...
Returns HTTP 200 when user is authenticated, 404 otherwise.
Name | Type | Info |
state | string | contains "authenticated" or "not authenticated" |
user | object | contains the authenticated user or null. The users structure is as described in the user API. |
DELETE call
For DELETE the sessionId must be part of the URL, like the usual ID parameter: /editor/session/SESSION_ID
Returns HTTP 200 when session was destroyed, 404 otherwise.
Instead of the session ID the
| Anchor | ||||
|---|---|---|---|---|
|
...