Page tree

Versions Compared

Key

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

The session API is located in the editor module, it enables authentication to translate5 via API.

Provides

...

actions about the authenticated user

User sessions can be created / deleted by this API. Also some status information to the authenticated user can be retrieved.

URL:

/editor/session/[SESSION_ID]

Available Methods:

GET/POST/DELETE

Specialities:

See below

POST Request

...

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.

DELETE call

For DELETE the sessionId must be part of the URL, like the usual ID parameter: /editor/session/SESSION_ID

Returns HTTP 200 when session was destroyed, 404 otherwise. 

Anchor
APIUsage
APIUsage
Using the received sessionId in other API calls

...