Abstract

This document outlines the technical specifications for integrating demand partners with CDLX.

In AdTech, a Demand Partner typically refers to an organization—such as an advertiser, agency, or demand-side platform (DSP)—that seeks to purchase digital ad inventory from publishers or supply-side platforms (SSPs). Demand Partners use technology platforms to automate and optimize the buying process, often leveraging APIs to connect with other platforms for efficient data exchange and campaign management.

This integration involves four key components: Merchant Ingestion API for managing merchant data, Offer Ingestion API for handling offer details, a Redemption Feed providing transaction information, and an Aggregate Reporting API for accessing performance metrics.

The document details data formats, file naming conventions, upload protocols using SFTP, and REST API endpoints for real-time updates, emphasizing secure and efficient data exchange. Adherence to these guidelines ensures seamless collaboration and optimized data handling between partners and CDLX.

Key Components of the Integration

The integration between Demand Partners and CDLX is structured around four key components:

Merchant Ingestion API: Focuses on onboarding and managing merchant data within CDLX systems.
Offer Ingestion API: Deals with the management of offers provided by partners and their ingestion into CDLX.
Redemption Feed: Provides partners with data on transaction redemptions.
Aggregate Reporting API: Provides endpoints that allow partners to retrieve performance metrics for their offers.

General Important Considerations:

Schema Adherence: Proper formatting and adherence to the defined JSON schemas are crucial for successful integration and to avoid processing errors.
Identifier Consistency: Maintaining consistent merchant and offer identifiers (merchantId, offerId) across all data exchanges is essential for tracking changes and ensuring data integrity.
Choice of Integration Method: Partners can choose between SFTP for batch processing (recommended for larger volumes) or REST APIs for near real-time updates (recommended for smaller volumes or immediate updates).
File Overwrite Policy: For both merchant and offer ingestion via SFTP, new files with the same name will overwrite existing ones.
Offer Activation and Deletion: Once an offer is activated by a consumer, it remains valid for redemption (and payout) for 30-45 days, even if the partner signals to take it down.

Summary

This documentation summarizes the key aspects of the Demand Partner Integration with CDLX. For detailed implementation, partners should refer to the sections below in the Table of Contents and adhere to the specified schemas, protocols, and guidelines.