WebSockets API
Ocelloids services WebSockets API documentation.
- Base URL
wss://api.ocelloids.net
Authorization
The Ocelloids WebSocket APIs employ a dual-token authentication mechanism for secure interaction with real-time data streams in both server and browser environments:
- Nod Token
- Clients request a “nod token” to be included in the query string of the WebSocket endpoint URL. This token has a short validity period and doesn’t grant access privileges, minimizing security risks if leaked.
- Access Token
- After verifying the “nod token”, the service expects an in-protocol message containing a valid access token for authentication and authorization.
Long-lived Subscriptions
- Endpoint
/ws/subs/:agentId/:subscriptionId
Parmeters
| Name | Description |
|---|---|
| agentId | The agent identifier, see Agents . |
| subscriptionId | The identifier of a persistent subscription. |
On-demand Subscriptions
- Endpoint
/ws/subs