configure()

Configures the shared Encore instance for use throughout your app. Call it once, at app startup, before any other SDK method. If your Encore flows include an in-app purchase, pass your purchase controller here. Binding it is part of configuring, so the SDK is never configured without the purchase path it was meant to have.

Signature

configure(apiKey: string, options?: ConfigureOptions): Promise<{ success: boolean }>

Parameters

Name	Type	Default	Description
`apiKey`	string	(required)	Your Live Key or Test Key from the Encore Dashboard settings
`options`	ConfigureOptions	`{}`	Optional configuration

Options

interface ConfigureOptions {
  purchaseController?: PurchaseController;
  logLevel?: 'none' | 'error' | 'warn' | 'info' | 'debug';
  unlock?: 'optimistic' | 'strict';
}

Option	Type	Default	Description
`purchaseController`	PurchaseController	(none)	Your billing code, bound as the SDK’s single purchase path. Omit it if your Encore flows have no in-app purchase. See Configuring without a purchase controller
`logLevel`	`'none' \| 'error' \| 'warn' \| 'info' \| 'debug'`	`'none'`	Logging verbosity level
`unlock`	`'optimistic' \| 'strict'`	`'optimistic'`	How a claim grants access. See Unlock mode

Unlock mode

'optimistic' records the claim and finishes. 'strict' verifies the claim server-side, persisting unverified claims and re-checking them across launches; those settle later as a strict_unlock_verified event on Encore.onOutcome. Set once, at configure. It selects how a claim flow runs, never how a result is read: the presentation record is written identically in both modes.

API keys

Key Type	Format	Description
Live Key	`pk_live_...`	Production key with standard geo-filtering based on offers’ configured regions
Test Key	`pk_test_...`	Development key. Serves demo offers instead of your inventory, and bypasses geo-filtering

Use the test key (pk_test_...) during development to exercise the entire entitlement lifecycle end to end. It serves a demo catalog, so the claim, the advertiser page, and the unlock all work without a live campaign or a real payout.Your own offers do not appear under a test key. For that, use the live key and accept that the traffic is recorded. See what a test key serves.

Always use your live key (pk_live_...) in production builds.

Usage

EncoreProvider (recommended)

import { EncoreProvider } from '@encorekit/react-native';
import type { PurchaseController } from '@encorekit/react-native';

const purchaseController: PurchaseController = async ({ productId }) => {
  const outcome = await yourBilling.purchase(productId);
  if (outcome.userCancelled) return 'cancelled';
  if (outcome.deferred) return 'pending';
  return 'purchased';
};

export default function App() {
  return (
    <EncoreProvider
      apiKey="pk_your_api_key"
      options={{ logLevel: __DEV__ ? 'debug' : 'none' }}
      purchaseController={purchaseController}
    >
      <YourApp />
    </EncoreProvider>
  );
}

The provider forwards the purchaseController prop into configure, which it calls once, on mount. Only the value from the first render is bound; swap it later with Encore.setPurchaseController() if it genuinely needs to change at runtime.

Direct configuration

import Encore from '@encorekit/react-native';

await Encore.configure('pk_your_api_key', {
  purchaseController,
  logLevel: 'debug',
  unlock: 'strict',
});

Configuring without a purchase controller

If your Encore flows include no in-app purchase, omit the option. The SDK then never attempts a purchase, logs its own sdk_iap_no_purchase_controller diagnostic, and every presentation records publisher: 'not_attempted'. That is a supported configuration and a more accurate record than a failure your app never caused.

Use logLevel: 'debug' during development to see detailed SDK logs, then 'none' for production builds.

PurchaseController, the shape of the purchaseController option.
onOutcome(), which unlock: 'strict' feeds late verifications into.

iOS

Android

Web

Bridges

Signature

Parameters

Options

Unlock mode

API keys

Usage

EncoreProvider (recommended)

Direct configuration

Configuring without a purchase controller

​Signature

​Parameters

​Options

​Unlock mode

​API keys

​Usage

​EncoreProvider (recommended)

​Direct configuration

​Configuring without a purchase controller

​Related

Signature

Parameters

Options

Unlock mode

API keys

Usage

EncoreProvider (recommended)

Direct configuration

Configuring without a purchase controller

Related