Client integration guide

Table of Contents


Authentication

In order to integrate with the Personalisation API, you need to supply a OAuth2 bearer token in the Authorization header of the request. Read more about authentication here.

Getting personalised offers

To get personalised offers, you don't integrate with personalisation directly, you instead supply metadata on the travellers when using the offers api. See offers guide here.

Getting the status of a customer

To get the status of a customer to show in your client, use

This endpoint returns the status of the customer in all the programs they are a member of. If you are interested in a specific program, you can use the programReference field in the query to only get the status for that program. The api will still return an array. If the customer is not a member of the program, the array will be empty, and if they are a member, the array will have one element.

You can set the statusAt field to get the status for a customer at a specific point in time. If no statusAt is set, the endpoint defaults to check status now.

Getting all periods for a member

To get all periods for a member in a period-based program, use

This will give you a paginated response with all the periods belonging to the member, containing basic info like start-time, end-time and metadata associated with the period. The end-time value can be used to get the final status for the given period in the endpoint described above.

Posting events via HTTP

Usually, events in personalisation are triggered from Kafka messages that are produced for example when a sale is made, or a ticket is activated. However, programs may also be configured to react to events coming from HTTP calls to the service. These events can be used if the program needs to do something as a result of a manual action, such as a member manually joining a program. If the program you are integrating with has configured any such triggers, you may trigger them with the following endpoint:

API reference

All endpoints available for use in client integration with Personalisation are listed here: Client API. Important changes to the API are listed here: Client API Changelog