Open Loyalty Documentation¶
Open Loyalty is a technology for loyalty solutions. It is geared towards starting new loyalty projects based on the Symfony Framework.
Note
This documentation assumes you have a working knowledge of the Symfony Framework. If you’re not familiar with Symfony, please start by reading the Quick Tour from the Symfony documentation.
The REST API Reference¶
The API Guide covers the REST API of the Open Loyalty platform.
- Introduction to the Open Loyalty REST API
- Authorization
- Admin Users API
- Analytics API
- Audit API
- Reward Campaigns API
- Customer API
- Customer Campaign API
- Customer Level API
- Customer Earning API
- Add label to Customer
- Customer Points transfers
- Earning Rule
- Invitation
- Level API
- Points transfers
- POS API
- Security
- Seller API
- Segment API
- Settings API
- Store API
- Transactions
- Utility API
- Campaigns categories API
- ACL API
- Event API
- Webhooks
Developer Documentation¶
The Developer’s Guide contains information for developers who want to know more about Open Loyalty architecture and the concepts used within. This guide helps developers to understand how Open Loyalty works.
- /developer/introduction
- /developer/installation
- /developer/architecture
- /developer/configuration
- /developer/points
The Cookbook¶
The Open Loyalty Cookbook is a collection of solution articles helping you with some specific, narrow problems.
- How to create a new bundle
- How to add a new API endpoint
- Creating new Commands and Handlers
- How to backup elasticsearch
- How to change the domain
- How to change main language
- How to schedule transactions import
- How to work with queues
- How to add a new field to an entity
- How to add a new tab in the admin panel
- How to enable LDAP authorization
- How to create a translatable field
- Open Loyalty FAQ