Display API#

The Antavo Enterprise Loyalty Cloud provides the Display APIs to assist in the rapid construction of a members’ loyalty site. These APIs allow direct, fast and full CRUD-like access to the loyalty-related features, settings and data for any given customer, identified by their customer id or external_IDs, if configured. This headless approach also enables the quicker and simpler integration of Antavo ELC data into your current client-facing interfaces, using your framework and tools of choice. There is also a level of future-proofing as the standard nature of the Display APIs means that they can be incorporated into any developments/innovations in user interface technology.

The Display APIs, like all Antavo APIs, follow a RESTful approach and in most cases, specific customer data is retrieved using GET requests from the individual endpoints. Data is returned in JSON format and can be easily incorporated into any type of user-facing interface, providing true cross-channel content distribution – Imagination is the only limit with the client having full control and access of all available data.

The Display API contains functionality which can also be delivered by other endpoints but the Display API provides a standard uniform API interface and structure.

Antavo ELC is the sole source of truth for all loyalty data and building interfaces using the Display API ensures that your customers can interact with the most up to date loyalty data available to them. This single source coupled with a single standard API access point is ideal for omnichannel customer approach where customer interactions can occur in numerous different scenarios with different technological interfaces. The member-only nature of Antavo ELC and its security measures means that all endpoints of the Content APIs are available under the customer namespace but only customer-accessible data is returned.

All server to server calls should follow the API security protocol and signing procedure and be aware of the API rate limits.

The OpenApi yaml file used to generate this documentation can be downloaded here