blazeauth
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

  1. Connect to the endpoint.
  2. Initialize the session by calling initialize within 15 seconds after connect. Until initialization succeeds, all other operations are rejected.
  3. Authorize (optional) by calling either auth_by_license or auth_by_credentials.
  4. Use the rest of the API (variables, file transfers, session values, etc.).
  5. Optionally call logout to drop the authorization state.
  6. Close the WebSocket connection.

What is stored inside a session

  • Initialization: application context resolved from your API key.
  • Client identity: client_id that you provide in initialize.
  • 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.

On this page