Skip to main content

Initial Setup

Before you send carts, sync catalogs, or call Customer endpoints, the integration project needs a working Company environment and Streaming API credentials. This section covers that bootstrap layer.

Guides​

GuideUse it for
API KeysCreate, enable/disable, and use X-Api-Key / X-Api-Secret / X-Api-Version safely.

Typical bootstrap order​

  1. Confirm sandbox and production Companies with the Loyal Guru team.
  2. Create or receive Streaming API keys (see API Keys).
  3. Store secrets outside source control; rotate when people or systems change.
  4. Sync Company Data and Customer Data.
  5. Run the Quickstart or Integration Tutorial.

HTTP behavior, rate limits, errors, and idempotency: HTTP API. Interactive schemas: API Reference.