Display API
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 EpisXperience 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.
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.
Endpoints Overview
The Display API is organized into distinct categories, each focusing on a specific set of functionalities:
Coupons: Endpoints listing all coupons associated with a specified customer, allowing customers to claim or revoke coupons, and retrieve all claimed coupons for a specified customer.
Customers: Endpoints providing core features for creating, logging in, activating customers, and resetting their passwords.
Promotions: Endpoints listing all available offers.
Rewards: Endpoints listing available rewards, allowing customers to claim or revoke rewards, submit bids for bidding rewards, and retrieve all claimed rewards for a specified customer.
Analytics: Endpoints providing detailed information and search capabilities for customer transactions, including transaction IDs, and statuses.
API Principles
The Display API follows RESTful principles, utilizing standard HTTP methods to interact with resources. All responses are formatted in JSON, ensuring easy integration into user interfaces.
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.