Terminology

Key Terms

  • API (Application Programming Interface): A set of rules and specifications that allows different software applications to communicate and exchange data with each other.
  • SFTP (Secure File Transfer Protocol): A secure method of transferring files between computers over a network, often used for batch data uploads.
  • REST API (Representational State Transfer Application Programming Interface): An architectural style for designing networked applications that relies on stateless communication using standard HTTP methods.
  • JSON (JavaScript Object Notation): A lightweight data-interchange format that is easy for humans to read and write and easy for machines to parse and generate.
  • Schema: A formal description of the structure and data types of a file or data structure, ensuring consistency and proper interpretation of the data.
  • Endpoint: A specific URL that represents a resource in a REST API, allowing applications to access or manipulate that resource using HTTP methods.
  • Payload: The actual data being transmitted in a request or response in an API call.
    Merchant Ingestion: The process of transferring merchant-related data from a Demand Partner to the CDLX system.
  • Offer Ingestion: The process of transferring offer-related data from a Demand Partner to the CDLX system.
    Redemption Feed: A data stream provided by CDLX to Demand Partners containing information about transaction redemptions related to their offers.
  • Aggregate Reporting API: An interface that allows Demand Partners to request and receive summarized performance data for their merchants and offers.
  • Merchant ID: A unique identifier assigned to a merchant by the Demand Partner.
  • Offer ID: A unique identifier assigned to an offer by the Demand Partner.
    Merchant Status: A field indicating the type of change (NEW, UPDATED, DELETED, NO-CHANGE) for a merchant record.
  • Offer Status: A field indicating the type of change (NEW, UPDATED, DELETED, NO-CHANGE) for an offer record.
  • File Dump: A complete export of all records (e.g., all merchants or all offers) in a file.
  • Base64 Encoding: A method of converting binary data into an ASCII string format, often used to embed images or other binary files within text-based data formats like JSON.
  • RPS (Requests Per Second): The number of API calls a client can make to a server within one second, often used to manage API usage and prevent overload.

What’s Next