SparkGlim LogoSparkGlim

Getting Started

Public onboarding sequence for a branded SparkGlim white-label integration.

OverviewGetting StartedAuthenticationAPI ReferenceCoverageIntegrations

Implementation Order

Do these in order before live traffic starts.

  1. 1. Ask a SparkGlim to enable white labeling for your creator account.
  2. 2. Get your issued API key pairyou. The plaintext secret is shown only once at issuance.
  3. 3. Choose your branded domain or subdomain and confirm it is active in the white-label account configuration.
  4. 4. Configure tenant payment providers, notification providers, and security settings with an admin before going live.
  5. 5. Sign every tenant API request with the issued secret and send the required headers on every call.
  6. 6. Use the versioned backend base path `/api/white-label/v1` for tenant operations.
  7. 7. Read responses using the standard `{ success, data, requestId }` envelope and log the `requestId` on your side for support.

Example Base URL

Use your branded domain or assigned white-label subdomain.

https://your-brand.example.com/api/white-label/v1