Overview.

The Reward Loyalty API enables integration with external systems, mobile apps, and custom workflows. This RESTful API provides programmatic access to core platform functionality.

💡 Looking for the Agent API? If you need machine-to-machine access for POS systems, AI agents, or automation tools, see the Agent API documentation. The Agent API uses long-lived API keys instead of login tokens and is designed for automated systems.

API Notice

ℹ️ Reward Loyalty is designed as a standalone platform with a complete web interface for all users. The API is a supplementary resource for developers who want to build custom integrations. Due to limited resources, it's not actively developed or supported.

What this means for you:

• Standalone-first — All platform features are fully accessible through the web interface without any API integration.
• Developer foundation — The API provides working endpoints that experienced developers can extend and customize for their specific needs.
• Limited support scope — API-related issues fall outside our standard support. Development resources are required to maintain your integrations.
• Review before purchasing — Check the interactive API documentation to verify available endpoints meet your requirements. The Agent API documentation is also available for machine-to-machine integrations.

Interactive Documentation

REST API (this API)

Full API documentation with request/response examples is available at:

https://your-domain.com/api/documentation

Browse the live REST API docs →

This Swagger UI interface lets you:

• Browse all available endpoints
• View request/response schemas
• Test endpoints directly (with authentication)

Agent API

The Agent API has its own dedicated OpenAPI specification:

Base URL

All API requests use your installation's domain:

https://your-domain.com/api/{locale}/v1

The {locale} parameter sets the response language (e.g., en-us, de-de).

Authentication

Most endpoints require Bearer token authentication via Laravel Sanctum:

Authorization: Bearer your-api-token

Obtaining Tokens

Tokens are obtained by calling the login endpoint for each user type:

Available Endpoints

Admin Endpoints

• Authentication: login, logout, profile
• Partner Management: list, get, create, update, delete
• Partner Permissions: get, update (for SaaS billing)
• Partner Usage: get usage vs limits

Partner Endpoints

• Authentication: login, logout, profile, update
• Clubs: list, get, create, update, delete
• Loyalty Cards: list, get, create, update, delete
• Stamp Cards: list, get, create, update, delete
• Staff Members: list, get, create, update, delete
• Members: list, get, create, update, delete
• Vouchers: list, get, create, update, delete
• Rewards: list, get, create, update, delete
• Transactions: add purchases, add points

Staff Endpoints

• Authentication: login, logout, profile
• Member Lookup: find by identifier
• Loyalty Operations: add purchase, redeem reward
• Stamp Operations: add stamps, redeem stamp reward
• Voucher Operations: validate code, redeem voucher

Member Endpoints

• Authentication: register, login, logout, profile
• Loyalty Cards: list all, followed, transacted, balance
• Stamp Cards: list enrolled, history, enroll (add to My Cards), unenroll (remove)
• Vouchers: list saved, save (add to My Cards), unsave (remove)

Response Format

All responses are JSON:

{
  "data": {
    // Response data
  }
}

Error responses include details:

{
  "message": "Error description",
  "errors": {
    "field": ["Validation error"]
  }
}

Rate Limiting

API requests are rate-limited to prevent abuse. If you exceed limits, requests return HTTP 429.

Extending the API

As a source code license holder, you can extend the API:

1. Create controllers in app/Http/Controllers/Api/
2. Add routes in routes/api.php
3. Add OpenAPI annotations for documentation
4. Run php artisan l5-swagger:generate to update docs

For guidance, refer to Laravel's official documentation and the existing API controllers as examples.

What's NOT Included

The following features may require custom development:

• Tier management endpoints
• Referral code endpoints
• Email campaign management
• Analytics/reporting endpoints
• Webhook management

These features are fully available through the web interface and can be exposed via API by extending the existing controllers.