Overview

The Reward Loyalty API enables integration with third-party platforms and services. Build custom frontends, mobile apps, or connect external systems.

Important Notice

The API provides a foundation for your own development. It covers core functionality but is not exhaustive. If you need additional endpoints, you'll need to extend the API yourself.

Consider your needs carefully. Evaluate whether the available endpoints meet your requirements before planning an integration.

Base URL

All API requests use your installation's domain:

https://your-domain.com/api

Authentication

API endpoints require authentication. Include your API token in the request header:

Authorization: Bearer your-api-token

Tokens are managed through the admin dashboard.

Response Format

All responses are JSON:

{
  "success": true,
  "data": {
    // Response data
  }
}

Error responses include details:

{
  "success": false,
  "error": "Error message",
  "error_code": "ERROR_CODE"
}

Rate Limiting

API requests are rate-limited to prevent abuse. Standard limits apply per token. If you exceed limits, requests return a 429 status code.

Available Resources

The API provides access to:

• Members
• Loyalty cards
• Points transactions
• Rewards

See the detailed endpoint documentation for specifics.

Extending the API

As a source code owner, you can extend the API:

1. Create new controllers in app/Http/Controllers/Api/
2. Define routes in routes/api.php
3. Follow Laravel API best practices

For guidance, refer to Laravel's official documentation.