For the response, we can have the following structure in case of an error:

Status Codes

This will be a high-level status code from the following:

Error Codes

This will be the error codes of the following type:

Introduction

Trueloyal APIs are subject to rate limits to safeguard against spikes in traffic and ensure system stability. This document outlines Trueloyal's rate-limiting policies to help you use the Trueloyal API efficiently.

Rate Limits

Some API endpoints require stricter limits. So all API endpoints are grouped into categories for rate limiting. The rate limits apply on a category. Categories and the API limit to each category are listed below:

• 50 Write API requests per minute
• 50 Member Eligibility API requests per minute
• 100 General API requests per minute

If these limits are exceeded, the server will return an error with the "429 Too Many Requests" HTTP status code along with the following response body. Once this error is received, the API call should be retried using the “Exponential backoff retry” strategy.

Example response:

{
    "reason": "Rate limit exceeded",
    "error_code": "RATE_LIMIT_EXCEEDED",
    "success": false
}

📘

Please Note:

• The rate limits mentioned apply to the standard plan. To check the rate limits applicable to your current plan, please write to your account manager at support@Trueloyal.com.
• If you anticipate a surge in API requests due to any promotional activity or special campaigns, please notify us in advance. Send your request to your account manager to ensure smooth operation during high-traffic periods.

API Category

Write APIs

• Create a Loyalty Member API
• Update a Loyalty Member with Member ID
• Update a Loyalty Member with Trueloyal Generated ID
• Award Points
• Redeem Points
• Deduct Points
• Return Points
• Approve a Pending Award/Redeem Transaction using ID
• Approve a Pending Award/Redeem Transaction using Unique Transaction Attribute
• Reject a pending award/redeem transaction using ID
• Reject a Pending Award/Redeem Transaction using Unique Transaction Attribute
• Modify a pending Award Transaction with Transaction ID
• Modify a pending Award Transaction using Unique Transaction Attribute
• Reverse Points with Transaction ID
• Reverse Points using Unique Transaction Attribute

Member Eligibility APIs

• List all the Eligible Activities for a Member using Trueloyal Generated Member ID
• List all the Eligible Activities for a Member using Member ID
• Get Eligible Rewards with Member ID
• Get Eligible Rewards with Trueloyal Generated Member ID

General APIs

• Retrieve a Loyalty Member with Member ID
• Retrieve a Loyalty Member with Trueloyal Generated ID
• List Members
• Delete a Loyalty Member with Member ID
• Delete a Loyalty Member with Trueloyal Generated ID
• List all activities
• Retrieve an Activity using Activity ID
• Retrieve an Activity using Trueloyal Generated ID
• Retrieve Custom Attribute for an Activity using Activity ID
• Retrieve Custom Attribute for an Activity using Trueloyal Generated ID
• List All Rewards
• Retrieve a Transaction with Transaction ID
• Retrieve a Transaction using Unique Transaction Attribute
• List all Transactions
• List all Transactions with Member ID
• List all Transactions with Trueloyal Generated Member ID
• List all Tiers API

Introduction

Trueloyal APIs handle sensitive data, requiring authentication through your account API keys for any calls made to the Trueloyal API.

This document provides guidance on generating API keys, their usage, and best practices.

Now, let's delve into this in more detail.

Generating API Keys

To generate an API key for your Trueloyal store, navigate to General >> API Keys and click on “Create API Key”.

Next, add a name and description to the API key you are generating, and then click on “Create API Key”.

The new API key will be listed on the page.

To generate more API keys for different instances, click on the “Create API Key” button and follow the same steps.

📘

Note: We highly recommend having different API keys for different integrations.

API Keys Actions

Show/Hide Action: To unmask the API key, click on the eye icon. After successful authentication, the API key will be presented. You can click on the eye icon again to mask the API key.

Copy Action: To copy the API key, use this icon.

Edit Key Details: You can edit the details like the name and description of the API key using this action.

Deactivate Key: Use this action if you wish to deactivate the API key. When the API key is disabled, APIs using that key will show an authentication error. A disabled API key can be enabled again.

Activate Key: To enable the disabled API key, select this action.

Delete Key: If you wish to delete the API key, select this action. This will hard delete the key. Once you select this action, a confirmation message will appear, and confirm it to proceed. This action will appear only when the API key is disabled.

📘

Key Notes:

• This API keys section will only be visible to admin with full access.
• All actions will be logged in the audit trail.
• Each program can have a maximum of 20 API keys.

Frequently Asked Questions

How will this impact my old integration with the default API keys?

This will not impact your old integration at all. However, if you wish to update the API key for your old integration, you will need to generate a new API key and replace the default one.

If you plan to use a new API key in the UI APIs or the Authentication JS, the JWT tokens will be created with the new API key. Along with this change, you also need to send the "API key identifier" so that Trueloyal can recognize that the tokens are generated with a new API key.