Get Started: Partner Integration

This guide will help you quickly understand your integration options, how to access and authenticate with our systems, and how to set up a sandbox environment for development and testing.

1. Integration Options

We offer two primary ways to ingest merchant and offer data into the Cardlytics platform:

A. REST API

Recommended for most partners due to real-time data transfer, ease of use, and robust error handling.
Integrate directly with our endpoints using HTTP requests.
Supports immediate data updates and validation responses.

B. SFTP (Secure File Transfer Protocol)

Best for partners with large data volumes, batch processing needs, or established file-based workflows.
Upload JSON files on a scheduled or ad-hoc basis.
Ideal for periodic or bulk data transfers.

Note:
Both REST API and SFTP use the same JSON schema for data formatting, ensuring consistency regardless of your chosen method. You may use either approach or a combination of both, but we recommend selecting a single primary integration path for simplicity and maintainability.

2. Access & Authentication

Your data security is our priority. Here’s how access and authentication work for each integration type:

Integration Type	Authentication Method	Authorization Controls
REST API	OAuth 2.0 (client credentials)	Unique client IDs/secrets, access tokens, possible IP restrictions, API scopes
SFTP	SSH Key Authentication	Unique username, registered public key, allowed IPs, directory permissions

Summary:

REST API:
- Secured with OAuth 2.0 client credentials flow.
- You’ll receive a unique client ID and secret.
- Access tokens are issued after successful authentication.
- Additional controls: API scopes, optional IP allowlisting.
SFTP:
- Secured with SSH key authentication.
- Each partner receives a unique username and a private SSH key (shared using PGP encryption).
- Access will be restricted by source IP and directory permissions.

3. Set Up a Sandbox for Testing

Before integrating with our production systems, we strongly encourage you to use our sandbox environment. This allows you to test, explore, and validate your integration in a safe, isolated setting.

More information coming soon.

Need Help?

Developer Documentation: Comprehensive API references and SFTP guides are available in our Developer Portal.
Support: Your account manager and technical team are here to help with onboarding, troubleshooting, and best practices.

Ready to get started?

Contact your Cardlytics representative to begin your integration journey today!