Introduction

TrueLoyal has two APIs. Which one you use depends on the part of TrueLoyal you're integrating with:

Loyalty API

The Loyalty API is organized around REST and made up of three APIs:

• The Admin API, authenticated with an API key and your partner ID.
• The UI API, designed for the front end, for example to build your own loyalty dashboard. It's authenticated with a JSON Web Token (JWT) and your partner ID, and its responses include limited data, unlike the Admin API.
• The Guest API, also designed for the front end. It's authenticated with your partner ID only and only returns basic program details.

See Authentication to create API keys and authenticate each API, Rate Limits and Status Codes. Every endpoint is described in the Loyalty API Reference. To be notified when something happens in your loyalty program, see Receiving Webhooks and the Loyalty Webhooks Reference.

Advocacy API

The Advocacy API is a RESTful API built on HTTP, served from https://api.tintup.com. It uses the OAuth 2.0 protocol to authorize applications to access data on behalf of users, and its requests and responses are formatted according to the JSON:API specification.

To get started, create an OAuth application and get an access token, then read the Important Notes about the headers every request needs. The other guides in this section explain the conventions shared by every endpoint, such as including related resources, pagination and versioning. Every endpoint is described in the Advocacy API Reference, and the events you can receive with webhooks in the Advocacy Webhooks Reference.