Required | Description |
---|---|
name | Your company/app name |
description | Short description (max 150 characters) of your app |
url | URL to your company/app |
image_url | Copy of your company logo or link to a press pack |
install_url | Your install URL, must be https Merchants who initiate installation from their LoyaltyLion account are sent here. It should require login / signup to your app. Once the merchant is authenticated with your app, it should redirect into the LoyaltyLion OAuth approval flow. |
redirect_url | Your redirect URL, must be https We redirect merchants here once they approve access for your app, for example: https://app.example.com/auth/loyaltylion . Landing on this page should initiate token exchange |
https://app.loyaltylion.com/oauth/authorize
, with the following parameters:
Param | Required | Description |
---|---|---|
client_id | yes | Your client id |
scope | yes | A comma separated list of resource scopes |
redirect_uri | yes | The return URL, which must match the URL provided to us at registration |
state | no | An encoded string that can be used to lookup and restore the previous state of your app, for example to identify users who are sent back to your app after authorization is complete |
redirect_uri
including a code
as query param you can swap for an access_token
.
For example:
POST
request with the code, your client id and your client secret.
Scope | Description |
---|---|
read_customers | Read-only access to customers, including their points, tiers, rewards and activities. Doesn’t include orders. |
write_customers | Read and write access to customers. Can 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 add emails to the list. |
read_orders | Read-only access to orders. |
write_orders | Read and write access to orders. Can create, update and cancel orders. |