POST session/connect

Connect to a session socket.

Example

POST /api/v1/session/connect HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer ...

{
  "client": "game"
}
----------------------------------------
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "socketUrl": "wss://ws1.ws.prod.theendlessmission.com/session",
  "accessToken": "eyJhb...Qjg"
}

Security

Authentication is required.

URL Parameters

NONE

Query Parameters

NONE

Request Body

NameDescriptionValue
clientthe type of client connecting; game indicates the actual game client, while portal indicates the Content Portal website (behavior of the socket may be modulated by client type)string;
one of:
  • game
  • portal

Response

Successful responses are code 200 with data in the response body. Other error responses are standard.

Response Body

NameDescriptionValue
socketUrlthe URL to use to establish a WebSocket connectionstring
accessTokena token granting access to the socket host, as a JWTstring