...
Name | Type | Info |
sessionId | string | the sessionId of the newly created session, can be used directly for further API communication. The here 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. |
...
For GET the sessionId must be part of the URL, like the usual ID parameter.: /editor/session/SESSION_ID
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. |
| Anchor | ||||
|---|---|---|---|---|
|
Translate5 does not use a traditional RESTful authentication, but uses sessions that for.
To use the API as a authenticated user, first a session must be generated by the above mentioned session POST call. The there received sessionId must be given on each other request to the API as cookie value.
| Code Block | ||||
|---|---|---|---|---|
| ||||
Cookie: zfExtended=GIVEN_SESSION_ID |