Overview
API keys allow you to authenticate with the LoyaltyLion API. Each key contains a unique token and a defined set of permissions (called scopes). API keys can be disabled or deleted at any time.
Creating API Keys
To create or view your API Keys, go to your LoyaltyLion dashboard, click Manage, and under the Settings section, select API keys.
You will be able to see a list of all existing API keys here. For each key, you will be able to see:
The key's name
The first 9 digits of the token
When the key was created
When the key was last used
The current state of that key (active, disabled, etc)
Click on Create API Key to generate a new key. In here, you can give your key a name, and choose which permissions (scopes) the key should have. These should reflect the needs of the application or integration you're connecting.
Once you click Create, your API will be created will then be shown your token.
❗️Important: Make sure you save this token in a secure location, as you will not be able to view this again beyond this screen, and will have to make a new one if forgotten.
API Key Scopes
Each API key has a set of permissions (scopes) that determine the actions it can perform. These scopes can be modified at any time. As a best practice, you should only enable the scopes you need for your integration.
Scope | Description |
read_customers | Read-only access to customer data, including their points, tiers, rewards and activities (does not include orders). |
write_customers | Read and write access to customer data. Allows you to add and remove customer points, change tiers and trigger customer activities. |
read_unsubscribes | Read-only access to the loyalty email unsubscribes list and unsubscribes webhook. |
write_unsubscribes | Read and write access to the loyalty email unsubscribes list. Can also add email addresses to that list. |
read_orders | Read-only access to order data. |
write_orders | Read and write access to orders. Can create, update and cancel orders. |
For more information on API keys, and how to use them, please refer to our developer documentation.