White Label API Docs

Public integration documentation for SparkGlim white-label tenants: authentication, routes, payloads, responses, and deployment notes.

What These Docs Are For

Use these pages to implement a branded SparkGlim white-label integration without needing internal admin access first.

The white-label backend is multi-tenant and server-side. These docs explain how an enabled tenant connects to the API, what to send on each route, how requests are signed, and what to expect back.

Core Principles

Backend-Only API

The white-label API runs in the standalone backend. Frontend apps should never hold white-label secrets.

Signed Requests

Tenant API requests are HMAC signed and scope checked on every call.

Tenant Isolation

Each account has isolated settings, providers, logs, and operational controls.

Synced Records

Operational records remain visible in SparkGlim while mirrored white-label data supports tenant-specific flows.