Configure the SDK - Encore SDK

Call configure() once, as early as possible in your application lifecycle, before any other SDK method. Only the API key is required:

import Encore from '@encorekit/web-sdk';

Encore.configure({
  apiKey: 'pk_live_yourpublishablekey',
});

Get your publishable Live key from the Dashboard under Settings → Project API Keys at dashboard.encorekit.com (use the Test key for staging and local development). It starts with pk_ and is safe to ship in client-side code.

The SDK is configure-once: only the first successful configure() call is honored; subsequent calls log a warning and are ignored. To change configuration, reload the page.

The options

interface EncoreConfig {
  apiKey: string;                              // required: pk_... from the Dashboard
  redemptionMode?: 'deferred' | 'immediate';   // app-wide default: 'deferred'; overridable per placement
  logLevel?: 'none' | 'debug';                 // 'debug' during integration only
}

Field-by-field contract: configure() reference. Two choices worth making up front:

User identity is not configured here. The SDK auto-generates an anonymous UUID and persists it in localStorage; attach your own stable id with identify() once you know it.
redemptionMode sets the app-wide default claim flow: 'deferred' (default; your code calls redeem() later) vs 'immediate' (one step). Placements can override it per surface. See Redemption Modes.

Full example

import Encore from '@encorekit/web-sdk';

Encore.configure({
  apiKey: import.meta.env.VITE_ENCORE_API_KEY, // never hardcode keys
  redemptionMode: 'immediate',                 // app-wide default; placements can override per surface
  logLevel: 'debug',                           // during integration only
});

configure() returns true on success and false on invalid input (it logs the reason; it does not throw). Verify the live values at any time:

Encore.isConfigured();                      // true
Encore.getConfiguration();                  // { apiKey, baseURL, ..., redemptionMode }
Encore.getCurrentUserId();                  // the anonymous UUID, or your identify()'d id
Encore.getVersion();                        // SDK version string

Supported Web Development Frameworks

The SDK works with every major web framework. Each guide shows where to call configure() and the full integration pattern, end to end:

React

EncoreProvider wraps your app; same options as configure(), passed as props

Vue

Call configure() in the root component’s onMounted hook

Svelte

Call configure() in the root component’s onMount hook

Angular

Wrap the SDK in a root-provided service that configures on construction

Vanilla JS

No bundler: load the UMD build from a script tag and use the EncoreSDK global

Next steps

User Management: anonymous ids, identify(), attributes, reset()
Present Offers: show offers and handle the result

​The options

​Full example

​Supported Web Development Frameworks

React

Vue

Svelte

Angular

Vanilla JS

​Next steps

The options

Full example

Supported Web Development Frameworks

Next steps