Register WebSocket Client

This endpoint allows B2B partner clients to register for a WebSocket connection. Upon successful registration, it returns authentication and authorization tokens for all required channels, along with binding events for each channel.

Endpoint

POST /api/v1/websocket/register

Security

BearerAuth: A valid Bearer token must be included in the request header.

Request Body

Content-Type: application/json
Schema: websocket.RegisterRequest
- socket_id (string, required): The unique identifier for the WebSocket connection.
- channel_name (string, optional): The name of the channel to register.

Responses

200 OK
- Content-Type: application/json
- Schema: websocket.RegisterResponse
- Description: Returns authentication and authorization details.
400 Bad Request
- Content-Type: application/json
- Schema: types.ErrorResponse
- Description: The request was invalid or cannot be otherwise served.
401 Unauthorized
- Content-Type: application/json
- Schema: types.ErrorResponse
- Description: Authentication credentials were missing or incorrect.
500 Internal Server Error
- Content-Type: application/json
- Schema: types.ErrorResponse
- Description: An error occurred on the server.

Summary

This endpoint is essential for establishing a secure WebSocket connection for B2B partners, providing necessary tokens and event bindings to facilitate communication across channels.