Overview
What the Blazeauth WebSocket API is, where it is used, and why it is simple to integrate.
Blazeauth WebSocket API is a language-agnostic interface for auth, licensing, session data, and file delivery over one persistent connection.
What this API is
Client packets
Client-initiated operations: request format, response schema, and statuses.
Server events
Server-initiated panel events and their payload contracts.
Status codes
Global API status values returned in operation responses.
Close codes
WebSocket session close reasons and when connection can be terminated.
Rate limiting
HTTP, close-code, and packet-level throttling rules used by the WebSocket API.
Where it is used
- Client authentication and authorization flows.
- License validation and binding flows.
- Reading app variables and session-scoped key/value data.
- Binary file transfer with resumable progress.
- Real-time panel event delivery on the same socket.
Who it is for
- SDK/library developers implementing Blazeauth protocol in any language.
- Client applications that need low-latency and convenient auth/licensing flows.
Why it is simple to integrate
- One connection for both request/response operations and server events.
- Predictable packet envelope (
type,id) for all client packets. - Uniform status-code model across all usecases.
- Clear split between text JSON packets and binary transfer frames.