points api home

EZ Loyalty Points API

Overview of the API

The EZ Loyalty Points API is designed for developers who want to build applications that interact with the EZ Loyalty rewards platform. This API provides comprehensive functionality for managing user points, rewards, partner activities, and more within the EZ Rewards ecosystem.

The Points API enables developers to:

• Manage user points and rewards
• Track user activities and achievements
• Access leaderboards and competitions
• Manage partner branding and configurations
• Handle subscriptions and notifications

Accessing the API

The EZ Loyalty Points API is available in both our test and production environments:

Environment	URL
Test	https://api.points.test.myezrewards.com
Production	https://api.myezrewards.com/points/

Authentication

All API endpoints require authentication using JWT Bearer tokens. To obtain a token, use the Authentication endpoint with a valid API key. See the Authentication documentation for details.

Authorization: Bearer {your_jwt_token}

API Structure

The Points API is organized into several controllers, each handling a specific area of functionality:

• Authentication - User authentication and token generation
• Users - User management and information
• User Points - Managing user points and history
• Rewards - Available rewards and redemption
• Partners - Partner management and configuration
• Leaderboards - Competitive leaderboards
• Competitions - User competitions and prizes
• Buckets - Managing point buckets for categorizing and tracking different types of points

For a complete list of available endpoints, see the API Controllers Summary.

Request and Response Format

The API accepts and returns data in JSON format. Most endpoints follow a standard response structure:

{
  "success": true,
  "data": { ... },
  "message": "Operation completed successfully"
}

Error responses typically include:

{
  "success": false,
  "message": "Error message describing what went wrong"
}

Rate Limiting

API requests are subject to rate limiting to ensure fair usage and system stability. If you exceed the rate limit, you will receive a 429 Too Many Requests response.

API Versioning

The Points API is versioned to ensure backward compatibility as new features are added. The current version is included in the API URL.

Swagger Documentation

Interactive API documentation is available through Swagger:

Environment	URL
Test	https://api.points.test.myezrewards.com/swagger
Production	https://api.myezrewards.com/points/swagger

Security Requirements

Access to the API must be made using TLS 1.2 or higher (less secure versions of TLS are not supported). Calls made over plain HTTP will fail.

Getting Started

To get started with the Points API:

1. Obtain an API key from the EZ Loyalty team
2. Use the Authentication endpoint to get a JWT token
3. Use the token in your API requests
4. Explore the various endpoints available in the API

For detailed information about specific endpoints, refer to the documentation for each controller listed in the sidebar.