QUICKSTART

Live in 5 minutes.

From API key to try-on rendering on your product page — three steps, no complex setup.

5-Minute Quickstart

This guide gets you from zero to a working AR try-on on a Shopify product page. For other platforms, see the Integrations guide.

Step 1 — Get your API key

Start a free trial to receive your sandbox and live API keys. Sandbox keys (lmg_sb_*) do not count against your session allowance.

Your keys are available in the partner dashboard under Settings → API Keys. Keep your live key secret — never commit it to a public repository.

Step 2 — Upload your shade catalog

LumeCore needs to know your product shades to render them. You can upload via CSV or the REST API.

CSV format CSV
sku,name,hex,finish,category LIP-001,Rose Crimson,#B8245C,matte,lip LIP-002,Nude Mauve,#C4849C,satin,lip LIP-003,Berry Gloss,#7A1A3E,gloss,lip

Upload at: Dashboard → Catalogs → Import CSV. Note your catalog_id from the response — you'll need it in Step 3.

Step 3 — Embed on your product page

Add these two snippets to your Shopify theme's product template (product.liquid or product.json):

In <head> HTML
<script src="https://cdn.lumeglint.com/sdk/v1/lumecore.min.js" data-key="lmg_sb_YOUR_SANDBOX_KEY"></script>
In product template body Liquid
<div id="lumecore-tryon" data-product-id="{{ product.id }}" data-catalog-id="cat_YOUR_CATALOG_ID"> </div>

That's it. Preview your product page — the LumeCore try-on widget will initialize automatically when a shopper visits.

Verify it's working

Open your browser's developer console. You should see:

Console output log
[LumeCore] SDK v1 initialized [LumeCore] Catalog loaded: 3 shades [LumeCore] Ready — waiting for camera activation

If you see errors, check that your API key is valid and your catalog ID matches an existing catalog in your account. For help, email [email protected].

Next steps

  • Switch to your live key before going to production
  • Set up webhook events to track shade selections in your analytics
  • Review the API Reference to customize session behavior