System Conversion Supported
Guide: System Conversion Supported for Click / Action / Sale
This guide explains the parameters and implementation details for integrating different types of conversions: Click Conversion, Action Conversion, Order Conversion, and Order Product Click Conversion.
1. Click Conversion
Use the following parameters for Click Conversion integration:
Parameter | Type | Value | Description |
---|---|---|---|
page_name |
string |
admin_click |
Use the general code from the General Settings tab. |
customFields |
json array |
[{"city":"cityName"}, {"countryName":"countryName"}] |
Optional dynamic values. |
base_url |
string |
Target URL | Get the Target Link from the General Settings tab, encode it with base64_encode , and assign to base_url . |
current_page_url |
string |
Client URL | Client URL where this API is called, encode it with base64_encode , and assign to current_page_url . |
af_id |
string |
Affiliate ID | Extract the Affiliate ID from the external link URL (e.g., NzdtSnkyMklYTWlXU1hIMDhCdkcydz09-Mi0yMA== ). |
script_name |
string |
general_integration |
Leave as is. |
2. Action Conversion
Use the following parameters for Action Conversion integration:
Parameter | Type | Value | Description |
---|---|---|---|
actionCode |
string |
admin_action |
Use the action code from the General Settings tab. |
customFields |
json array |
[{"city":"cityName"}, {"countryName":"countryName"}] |
Optional dynamic values. |
base_url |
string |
Target URL | Get the Target Link from the General Settings tab, encode it with base64_encode , and assign to base_url . |
current_page_url |
string |
Client URL | Client URL where this API is called, encode it with base64_encode , and assign to current_page_url . |
af_id |
string |
Affiliate ID | Extract the Affiliate ID from the external link URL (e.g., NzdtSnkyMklYTWlXU1hIMDhCdkcydz09-Mi0yMA== ). |
script_name |
string |
general_integration |
Leave as is. |
3. Order Conversion
For Order Conversion, call a separate API using the following parameters:
Parameter | Type | Required | Description |
---|---|---|---|
product_ids |
integer |
Yes | The ID of the product(s) associated with the order. |
order_id |
integer |
Yes | The unique order number. |
order_currency |
string |
Yes | Currency code for the transaction (e.g., USD , INR ). |
order_total |
decimal |
Yes | Total amount of the order. |
customFields |
json array |
No | Optional dynamic values (e.g., [{"city":"cityName"}, {"countryName":"countryName"}] ). |
base_url |
string |
Yes | Get the Target Link from the General Settings tab, encode it with base64_encode , and assign to base_url . |
current_page_url |
string |
Yes | Client URL where this API is called, encode it with base64_encode , and assign to current_page_url . |
af_id |
string |
Yes | Extract the Affiliate ID from the external link URL (e.g., NzdtSnkyMklYTWlXU1hIMDhCdkcydz09-Mi0yMA== ). |
script_name |
string |
Yes | Use general_integration . |
4. Order Product Click Conversion
Use the following parameters for Order Product Click Conversion integration:
Parameter | Type | Value | Description |
---|---|---|---|
product_id |
string |
ProductID |
Pass the static value "ProductID" . |
customFields |
json array |
[{"city":"cityName"}, {"countryName":"countryName"}] |
Optional dynamic values. |
base_url |
string |
Target URL | Get the Target Link from the General Settings tab, encode it with base64_encode , and assign to base_url . |
current_page_url |
string |
Client URL | Client URL where this API is called, encode it with base64_encode , and assign to current_page_url . |
af_id |
string |
Affiliate ID | Extract the Affiliate ID from the external link URL (e.g., NzdtSnkyMklYTWlXU1hIMDhCdkcydz09-Mi0yMA== ). |
script_name |
string |
general_integration |
Leave as is. |
General Notes:
- Dynamic Parameters:
- Use
customFields
for optional dynamic data, such as user location (city
,countryName
).
- Use
- Encoding URLs:
- Always encode the
base_url
andcurrent_page_url
withbase64_encode
.
- Always encode the
- Affiliate ID:
- Ensure that
af_id
is correctly extracted from the external link for accurate tracking.
- Ensure that
- Testing:
- Test each conversion type thoroughly to ensure data is correctly passed to the affiliate system.
- API Endpoints:
- Ensure the correct API endpoint is called for each conversion type.