API
Outlines the technical and procedural steps required to enable businesses to deliver personalized offers and rewards
Abstract
The API - Integration Guide is a comprehensive resource for implementing and integrating the Cardlytics Rewards platform. The guide outlines the technical and procedural steps required to enable businesses to deliver personalized offers and rewards to their customers through Cardlytics' platform. It provides details on account setup, user journeys, API integrations, security requirements, and strategies for maximizing customer engagement with targeted promotional offers. The document also describes post-implementation testing, privacy controls, and advanced functionalities such as real-time reward notifications.
Summary
The API - Integration Guide is structured to assist developers and organizations in integrating into their systems. Below are the key components and highlights of the document:
-
Step-by-Step Integration Process:
- Initial account setup by CDLX.
- User journey steps, including obtaining session tokens, linking customer accounts via the Link SDK, fetching offers, activating them, and handling reward notifications.
- Testing and validation using the Cardlytics Testing Tool.
-
Authentication:
- Secure POST requests to obtain session tokens.
- Token caching, expiration handling, and error responses.
-
Link SDK:
- Methods for managing account linking (e.g., checking status, starting and deleting links).
- Integration via script tags and API calls.
-
Offers and Rewards Management:
- API endpoint for fetching ads tailored to specific customers or fallback offers for unlinked accounts.
- Detailed request and response structures, including optional filters such as category, activation state, visibility state, and more.
- Explanation of ad lifecycle states (e.g., activation, visibility, redemption).
-
Client Event Logging:
- Logging user activity and interactions with offers, including impressions, activations, and session-level events.
-
Welcome Basket Offers:
- Placeholder offers for new Cardlytics Rewards Platform users until sufficient transaction data is collected for personalized recommendations.
-
Reward Notifications:
- S3 File Transfer and Real-Time Messaging (RTM) Webhooks to immediately relay Redemption events as they occur..
-
Category Mapping:
- A detailed mapping of customer-facing categories to internal classifications for better offer targeting.
-
Security Requirements:
- Guidelines for securing sensitive data, including obfuscation of the
x-source-customer-id
using the HMAC-SHA-256 algorithm.
- Guidelines for securing sensitive data, including obfuscation of the
This guide provides detailed technical instructions, sample payloads, and response formats to ensure smooth integration. It also emphasizes security, scalability, and the ability to dynamically adapt to customer preferences and offer performance.
Updated 11 days ago