Installation

Get up and running with the Loyalty SDK in your project. This guide covers prerequisites, installation, and initial configuration.

Prerequisites#

Before installing the Loyalty SDK, make sure you have the following:

Node.js version 18 or higher is required. You can check your version with node --version. You'll also need a package manager like npm, yarn, or pnpm.

Install the SDK#

Install the Loyalty SDK using your preferred package manager:

npm install @loyalty/sdk

Or with yarn:

yarn add @loyalty/sdk

Or with pnpm:

pnpm add @loyalty/sdk

Environment Setup#

Create a .env.local file in your project root and add your Loyalty API credentials:

LOYALTY_API_KEY=your_api_key_here
LOYALTY_API_SECRET=your_api_secret_here
LOYALTY_PROGRAM_ID=your_program_id

Initialize the Client#

Create a Loyalty client instance in your application:

import { LoyaltyClient } from "@loyalty/sdk";

const loyalty = new LoyaltyClient({
  apiKey: process.env.LOYALTY_API_KEY!,
  apiSecret: process.env.LOYALTY_API_SECRET!,
  programId: process.env.LOYALTY_PROGRAM_ID!,
});

export default loyalty;