Developer

Page tree

Versions Compared

Old Version 8

changes.mady.by.user Thomas Lauria

Saved on

compared with

New Version 9

changes.mady.by.user Marc Mittag

Saved on

Key

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

...

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.
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.

...

Translate5 does not use a traditional RESTful authentication, but uses sessions that for this purpose.

To use the API as a an 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 HTTP header.

...