Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name

Type

Info

login

string

The user to be authenticated.

passwd

string

The passwd of the user to be authenticated.

taskGuidstring

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.
Users authenticate themselves on your system, your system authenticates them via API at translate5.
Your system then provides a link containing the sessionToken parameter:
  /editor?sessionToken=RECEIVED_TOKEN
After clicking on this URL translate5 will be opened with the authenticated user.
The token is only callable one time to prohibit misusage.

taskUrlPath
stringThe URL path part to the task, if in POST request a taskGuid was provided.


GET resulting resource layout

...