Skip to main content

Token

Overview​

The Telex Token API provides endpoints to generate tokens for various purposes within your application. This includes generating connection tokens for establishing server connections to Centrifugo and subscription tokens for subscribing to specific channels.

Generate Connection Token​

  • Endpoint: GET /token/connection
  • Summary: Generate connection token
  • Security: bearerAuth
  • Description: Retrieve a connection token for establishing a connection to the server.

Responses​

  • 200: Connection token retrieved successfully.
{
  "status": "success",
  "status_code": 200,
  "message": "Connection token retrieved successfully",
  "data": {
    "token": "your_connection_token_here",
  }
}
  • 400: Bad request.
{
  "status": "error",
  "status_code": 400,
  "message": "Bad request",
  "error": "Invalid parameters"
}
  • 401: Unauthorized.
{
  "status": "error",
  "status_code": 401,
  "message": "Unauthorized",
  "error": "Invalid or missing authentication token"
}

Generate Subscription Token​

  • Endpoint: POST /token/subscription
  • Summary: Generate subscription token
  • Security: bearerAuth
  • Description: Generate a token for subscribing to a specific channel.

Request Body​

  • Content-Type: application/json
  • Required: true
{
  "channel_id": "01910544-d1e1-7ada-bdac-c761e527ec91"
}

Responses​

  • 200: Subscription token generated successfully.
{
  "status": "success",
  "status_code": 200,
  "message": "Subscription token generated successfully",
  "data": {
    "token": "your_subscription_token_here",
  }
}
  • 400: Bad request.
{
  "status": "error",
  "status_code": 400,
  "message": "Bad request",
  "error": "Invalid parameters"
}
  • 401: Unauthorized.
{
  "status": "error",
  "status_code": 401,
  "message": "Unauthorized",
  "error": "Invalid or missing authentication token"
}