Getting Started

Overview

LoyalPro provides a comprehensive REST API that enables you to build powerful loyalty programs for your business. This guide will walk you through the essential steps to integrate LoyalPro into your application.

Prerequisites

Before you begin, make sure you have:

• A LoyalPro account (sign up for free at loyalpro.com)
• Basic knowledge of REST APIs
• A development environment with Node.js, Python, or PHP
• An HTTP client like cURL, Postman, or Insomnia

Authentication

LoyalPro uses API keys to authenticate requests. You can manage your API keys from your dashboard. Your API keys carry many privileges, so be sure to keep them secure.

Authorization: Bearer YOUR_API_KEY
X-LoyalPro-Version: 2025-01-01

Installation

Install the LoyalPro SDK for your preferred programming language:

Make Your First API Request

Let's create your first customer in LoyalPro. Here's a simple example:

const LoyalPro = require('@loyalpro/node-sdk');

const loyalpro = new LoyalPro('sk_test_your_api_key');

// Create a new customer
const customer = await loyalpro.customers.create({
  email: 'customer@example.com',
  name: 'John Doe',
  phone: '+234 801 234 5678'
});

console.log(customer);

{
  "id": "cus_abc123xyz",
  "email": "customer@example.com",
  "name": "John Doe",
  "phone": "+234 801 234 5678",
  "points_balance": 0,
  "tier": "Bronze",
  "created_at": "2025-01-15T10:30:00Z"
}

Next Steps