Developer Quickstart

Use this guide to make the first correct integration decision and arrive at a testable SPREEAI experience.

1. Pick the path

• Use the Shopify App when the storefront is on Shopify and a managed app block is sufficient.
• Use the Web SDK when the storefront is headless or needs custom placement, styling, sizing, and cart behavior.
• Use a native SDK for an existing iOS or Android shopping app.
• Use the public API reference only for a server-side workflow approved during onboarding.

2. Define one first journey

Agree on:

• one channel;
• one catalogue group;
• one customer moment;
• one primary measure of success; and
• the owner of staging, catalogue preparation, QA, and launch.

3. Prepare access

For the Web SDK, SPREEAI issues an approved client ID during onboarding; v3 resolves the partner from that client ID. Never place a client secret in front-end code.

For the Shopify App, install the current app and complete its managed onboarding flow. The current flow connects the store after the agreements and subscription step; it does not require copying API keys into the setup screen.

4. Prepare garments

Each enabled garment should have a stable product or garment identifier and suitable imagery. See Garment asset requirements.

5. Integrate in staging

Use a duplicated Shopify theme, non-production deployment, or partner-issued development environment. Confirm the experience appears only for eligible garments and variants.

6. Validate and launch

Complete QA and launch, obtain brand approval, then enable Ready garments and publish the staged storefront change.

Need help?

Email support@spreeai.com with the environment, product or garment ID, browser or device, approximate timestamp, and reproduction steps. Never include a secret or access token.