Connexion

WebSocket API Documentation: Connection Action

Request Example

{
    "action": "Connection",
    "checksum": "azerty"
}

Fields:

  • action (string): Specifies the API action to execute. For connection, use "Connection".

  • checksum (string): A checksum to ensure the integrity of the request data. Provide a precomputed hash based on your API implementation.

Response Example

{
    "route": "Connection",
    "status": "success",
    "token": "eyJhbGciOiJIUzI1NiIsInR5c.iLsioueI4__2zazC3JxbsCvb22LXyQKIr0QZd8aEyYk"
}

Fields:

  • route (string): Indicates the API route or action associated with the response. Matches the request's "action" field.

  • status (string): Describes the result of the request. Possible values include:

    • "success": The connection was successful.

    • "error": The connection failed. Additional error details may be provided.

  • token (string): A JWT (JSON Web Token) issued upon successful connection. This token is used for authenticating subsequent requests.

PreviousRegisterNextDisconnect

Last updated