Protocol
WebSocket endpoints
Where to connect and how the Blazeauth session lifecycle works.
WebSocket endpoints
Blazeauth uses a stateful WebSocket session. One WebSocket connection holds your initialization and authorization state.
Endpoint
Production (EU):
WebSocket endpoint
Production (EU).
Lifecycle
- Connect to the endpoint.
- Initialize the session by calling
initializewithin 15 seconds after connect. Until initialization succeeds, all other operations are rejected. - Authorize (optional) by calling either
auth_by_licenseorauth_by_credentials. - Use the rest of the API (variables, file transfers, session values, etc.).
- Optionally call
logoutto drop the authorization state. - Close the WebSocket connection.
What is stored inside a session
- Initialization: application context resolved from your API key.
- Client identity:
client_idthat you provide ininitialize. - Authorization: either a license-based identity or a credentials-based identity.
- Session key-values: values set via
set_session_value(memory-scoped to the connection).
If you reconnect, you start with a fresh session and must initialize again.