Streaming API Reference
The Streaming API is the real-time API used by POS, e-commerce, app, kiosk, middleware, and backend systems to connect with Loyal Guru at runtime.
What it covers
| Area | Reference |
|---|---|
| Full interactive OpenAPI (schemas, examples, operations) | https://doc.loyal.guru/ |
| HTTP behavior, rate limits, errors, types, language, idempotency | HTTP API (short summary only) |
| Endpoint catalog by module (Markdown summary) | Endpoints |
Base URL and authentication
Always use https://doc.loyal.guru/ for the live Streaming API reference.
Every authenticated request must include API credentials:
X-Api-Key: <api-key>
X-Api-Secret: <api-secret>
X-Api-Version: 1
For implementation guidance, see the Integrations overview and the module-specific integration guides.