Get Connection Config
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Get WebSocket Connection Config
This endpoint provides the necessary configuration details for establishing a WebSocket connection. It is designed for B2B partners who need to connect their WebSocket clients to the Hermes service.
Endpoint
GET /api/v1/websocket/connection-config
Headers
Authorization: Bearer token required.
Include the
Bearerprefix before your access token in the Authorization header. For example:Bearer YOUR_ACCESS_TOKEN. Retrieve your access token from the/auth/loginendpoint response.
Description
Retrieve the configuration required to connect to the WebSocket service. This includes authentication details and connection parameters necessary for establishing a secure and reliable connection.
Security
- Bearer Token: Required for authentication. Ensure that the token is valid and included in the request header.
Responses
-
200 OK: Successfully retrieved the connection configuration.
- Content-Type:
application/json - Schema:
types.SuccessResponse
- Content-Type:
-
500 Internal Server Error: An error occurred on the server side.
- Content-Type:
application/json - Schema:
types.ErrorResponse
- Content-Type:
Usage Example
GET /api/v1/websocket/connection-config HTTP/1.1
Host: api.sandbox.prophetx.dev
Authorization: Bearer <token>Notes
- Ensure that your client is prepared to handle both success and error responses.
- This endpoint is part of the WebSocket API and is crucial for initializing connections.
Tags
- WebSocket
Contact
For further assistance, please contact [email protected].