Install the SDK - Encore SDK

The Encore Web SDK is a lightweight, dependency-free JavaScript/TypeScript library that displays targeted offers in your web app. It’s framework-agnostic: it works with React, Vue, Angular, Svelte, or plain JavaScript.

New to Encore? Start with the Getting Started Guide for account creation and guided setup. You’ll need your publishable API key (pk_...) from dashboard.encorekit.com.

Install

npm
yarn
pnpm
Script tag (UMD)

npm install @encorekit/web-sdk

yarn add @encorekit/web-sdk

pnpm add @encorekit/web-sdk

For projects without a build system, the package ships a UMD bundle at dist/umd/encore.min.js (global name Encore). Serve it with your own assets:

<script src="/vendor/encore.min.js"></script>
<script>
  // The UMD global exposes the SDK instance on .default
  var EncoreSDK = Encore.default || Encore;
  EncoreSDK.configure({ apiKey: 'pk_live_yourpublishablekey' });
</script>

A hosted CDN URL for the script tag is available. Confirm the current URL with your Encore contact before shipping, or self-host dist/umd/encore.min.js from the npm package (the always-safe option).

Verify

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

console.log('Encore SDK version:', Encore.getVersion());

TypeScript types are bundled, so no extra packages are needed:

import Encore, { type EncoreConfig, type ShowResult } from '@encorekit/web-sdk';

Browser support

Chrome/Edge, Firefox, and Safari (last 2 versions each); iOS Safari 15+. The SDK targets ES2022 and uses fetch and localStorage (with sessionStorage and in-memory fallbacks); no polyfills are needed on supported browsers. If you use a Content Security Policy, allow the Encore API host:

connect-src 'self' https://api.encorekit.com;

Next steps

Configure the SDK: initialize with your API key
User Management: anonymous ids and identify()
Present Offers: show offers in your app

​Install

​Verify

​Browser support

​Next steps

Install

Verify

Browser support

Next steps