Overview
Steps for API integration
The Cardlytics team will provide you with a suite of APIs and developer tools that cover transaction ingestion, notifications, redemptions, servicing and marketing. Using these APIs and tools, you can build a complete rewards experience for your customers, with a suite of supporting products that enable program operations.
Steps
To perform publisher integrations with the Cardlytics platform, follow these steps:
-
Prerequisites: Ensure you have established connectivity for ongoing data transfer and services. This involves setting up Amazon S3 buckets for file transfers and sharing customer transaction data with Cardlytics.
-
Integration: Follow the steps outlined for API integration.
-
Authentication: Obtain a session token for authentication, which is a JSON Web Token representing session metadata.
-
Connectivity: Establish secure connectivity using HTTPS and sFTP over mTLS, with IP address whitelisting and two-way SSL.
-
Testing: Conduct pre-production and production testing to verify connectivity and integration using endpoints like
startSession
,getAds
, andclientEvent
. -
Monitoring and Reporting: Utilize Cardlytics' reporting tools to track customer engagement and program performance, and monitor dashboards for ongoing operations.
Example: How to Start a Session
Here is a basic example of how you might start a session using curl:
curl -X POST https://pub-api-us.prod.cardlytics.com/startSession \
-H "Content-Type: application/json" \
-d '{"institutionId": "your_institution_id", "customerId": "your_customer_id"}'
This command initiates a session by sending a POST request to the startSession
endpoint with the necessary headers and data.
For more information, refer to these sections:
Updated 13 days ago