Zeals Affiliate Integration Guide
Overview
This document is intended for Zeals Affiliate partners to help integrate their system with ours.
The following diagram is an overview of general Zeals flow and where partner integration will take place within, assuming the partner already has front-end and back-end.
Referring to the above diagram, the blue circles represent integrations that partners will have to perform.
These are the things partners need to do:
Input partner campaigns (To be done by partner's operations team after being given access to Zeals Dashboard)
Integrate Zeals into your platform via our REST API
What Zeals Will Append to Your Landing Pages
Affiliate performance tracking with Zeals Affiliate relies on Zeals Code that we will send as URL parameter.
Example:
It is important to pass this value back via our REST API.
REST API
Hit our API when an acquisition happens. Our API endpoint is as follows:
URL |
|
|---|---|
Method |
|
Authentication |
|
Request Body | {
"zeals_code": "xxx",
"external_id": "yyy",
} |
Response |
|
Explanation
Key | Description |
|---|---|
PARTNER_ID | Zeals-assigned partner ID that we will send to you. |
zeals_code | Automatically generated hashcode by the Zeals platform, containing unique information about the affiliate and the campaign. |
external_id (Optional) | Transaction ID in your system. |