LumeCore Documentation

LumeCore is the AR try-on infrastructure layer that beauty brands embed in their storefronts. The SDK runs on-device via WebAssembly — no video stream leaves the browser, and shade switching happens at sub-100ms with no server round-trip. This documentation covers integration across every supported platform, shade catalog configuration, analytics, and the REST API.

What's included

• LumeCore JS SDK — Web embed for Shopify, WooCommerce, React, and any headless storefront.
• iOS SDK — Swift Package for native iOS apps. Minimum iOS 14, ARKit required.
• Android SDK — Kotlin library via Maven Central. Minimum API 26, ARCore required.
• REST API — Sessions, Shade Catalog, and Analytics endpoints.
• Webhook events — Real-time events for shade selection, session start/end, cart intent.

Quick navigation

• 5-Minute Quickstart — Get try-on rendering on a Shopify product page in under an hour.
• API Reference — Full endpoint documentation with request/response examples.
• SDK Overview — Code samples for JS, React, iOS Swift, and Android Kotlin.
• Integrations — Platform-specific guides for Shopify, WooCommerce, and headless stacks.

Authentication

All API requests require an Authorization: Bearer lmg_live_YOUR_KEY header. API keys are scoped per environment (live vs. sandbox). Keep your live key out of client-side code — use the data-key attribute in the JS embed only for the web SDK, which uses a publishable key variant.

Rate limits

The REST API is rate-limited to 1,000 requests per minute per API key. Session creation calls are counted separately and billed per your plan's session allowance. Sandbox keys have a 100 req/min limit.

SDK versioning

The CDN embed URL is versioned: https://cdn.lumeglint.com/sdk/v1/lumecore.min.js. Minor updates are applied automatically within a major version. To pin to a specific release, use /sdk/v1.2.0/lumecore.min.js. Breaking changes only happen on major version increments.