| Note |
|---|
If the API changes in an incompatible manner this is listed explicitly in the "important release notes" section of each releases changelog. |
The session API is located in the editor module, it enables authentication to translate5 via API.
...
Name | Type | Info |
login | string | The user to be authenticated. |
passwd | string | The passwd of the user to be authenticated. |
| taskGuid | string | Optional and obsolete: The taskGuid of the task which should be opened for the user. Obsolete since accessing and opening tasks is now controlled by the URL. So just navigate to /editor/taskid/123/ |
POST resulting resource layout
...
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. |
...
taskUrlPath | string | The URL path part to the task, if in POST request a taskGuid was provided. |
GET resulting resource layout
...
Instead of the session ID also the internalSessionUniqId can be provided. Thats possible for DELETE only, and the calling user must be an API user.
Special session api calls
URL: | /editor/session/impersonate |
Available Methods: | GET |
| Parameters: | login |
Specialities: | Impersonate/log-in as different user in translate5. The "user to impersonate" is defined as GET "login" parameter (ex: /editor/session/impersonate?login=manager4). Once you are authenticate/impersonate user with no api roles, you can no longer use this action (because of api only users acl restriction). |
| Requirements: | Authenticate user with api role is required. Also the "login" parameter is mandatory. |
| Anchor | ||||
|---|---|---|---|---|
|
...