Getting Started with the API

Overview

To get started with the Cardlytics Publisher API, you'll begin by making a POST call to start a session, which will enable you to retrieve a session token. Once you have that token, you'll be able to make API requests.

Two scopes are provided for you to work with: institution- or customer-level.

Typically, most banks will start with the customer-level scope. By selecting that scope, you can create a customer profile using the Data APIs. That is the beginning of your integration. Ad creation follows from that step forward.

Explore the topics described below to get a better understanding of the steps you'll need to follow to start a session and begin your integration, as well as the data model and flow, processes and services, and transaction share.

Topics

Topic	Description
Get Started with the Publisher v2.0 API	Describes the steps you need to take to begin your integration.
Start a Session & Specify Scopes to interact with APIs	Describes session tokens and scopes for API access.
Integration Processes & Services	Describes the high-level processes and procedures for integration.
Share Transaction Data	Explains what Cardlytics requires publishers to share as far as customer transactions.
Understanding the Data Model & Flow	Explains how the data model and flow work.