Developer

Page tree

Versions Compared

Old Version 14

changes.mady.by.user Thomas Lauria

Saved on

compared with

New Version 15

changes.mady.by.user Thomas Lauria

Saved on

Key

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


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

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.

...


GET resulting resource layout

...