The Display APIs provide comprehensive access to loyalty-related features, settings, and data for any customer. They facilitate the fast creation of loyalty sites and enable seamless integration of Antavo data into existing customer-facing interfaces using any preferred framework and tools. The standardized nature of these APIs ensures future compatibility with evolving user interface technologies.
Key Features
- Unified API interface and structure: Ensures consistency across different endpoints.
- Omnichannel support: Facilitates customer interactions through various technological interfaces.
- Robust security measures: Ensures data is accessible only within the customer namespace.
For more information about using pagination, filtering, and ordering with supported Display API endpoints, see the Pagination, filtering, and ordering documentation.
Endpoints Overview
The Display API is organized into distinct categories, each focusing on a specific set of functionalities:
- Activities: Endpoints that collect and aggregate all activities, including earning and spending activities.
- Challenges: Endpoints provided by the Challenges module, returning all active and completed challenges available for the customer.
- Content consumption: Endpoints provided by the Content consumption module, returning content consumption activities.
- Contests: Endpoints provided by the Contests lite module, returning contest activities and allowing customers to enter contests.
- Coupons: Endpoints provided by the Coupons module, returning all coupons associated with a specified customer.
- Customers: Endpoints providing core features for creating, logging in, activating customers, and resetting their passwords.
- Data extensions: Endpoints for accessing customer data extensions.
- History: Endpoints providing detailed information on events registered on customers' event streams.
- Offers: Endpoints provided by the Offers module, listing all available offers.
- Profiling: Endpoints provided by the Gamified profiling module, listing all available profiling flows, retrieving the next flow question, submitting answers, and accessing customers' answers to profiling questions.
- Prize wheels: Endpoints provided by the Prize wheels module, listing all available prize wheels, detailing each individual slice, and entering customers into specified prize wheel draws.
- Quizzes: Endpoints provided by the Quizzes module, listing all quiz activities, retrieving quiz details, and submitting quiz answers.
- Rewards: Endpoints provided by the Rewards module, listing available rewards, allowing customers to claim or revoke rewards, submit bids for bidding rewards, and retrieve all claimed rewards for a specified customer.
- Transactions: Endpoints providing detailed information and search capabilities for customer transactions, including transaction IDs, and statuses.
- Treasure hunt: Endpoints provided by the Online treasure hunt module, returning available treasure hunts.
- Wallet: Endpoints provided by the Wallet module, returning all available wallet passes assigned to customers.
API Principles
The Display API follows RESTful principles, primarily utilizing GET requests to retrieve specific customer data from various endpoints. While GET requests are the most common, some endpoints operate using POST requests. The responses are formatted in JSON.
Security and Compliance
All server-to-server calls must comply with the API security protocol and signing procedure and adhere to the defined API rate limits.