IronClick's Rest API allows you to send and receive reports of the actions in your campaigns.

The API uses the HTTP standard which accepts requests and returns JSON encoded responses.

Here are the actions that can be performed using the API:
Click - report of a click on an ad in your campaign.
Conversion - report on a conversion in your campaign.
Disqualification – disqualification of a conversion in one of your campaigns.
Information - actions that give additional insights about the effectiveness of the campaign.

Note:
The API is optional but recommended as the preferred form of interfacing.
You can interface also in a simpler way by embedding JavaScript code on the website.
See more details on the matter (and the possibility to perform tests) in your campaign settings.

For every request to the Iron Click server, we need to verify that the referral did come from you, therefore it is mandatory to pass in the Header of the referral, an Authorization parameter that contains your personal API KEY.

Find below the explanation how to create a click:
POST:
/api/v1/createclick
Host:
https://www.ironclick.net
Content-Type:
application/json
Authorization:
{Put your api key}
The request:
{ "AffiliateID": 15, "AdId": 34, "Tracker": "tracker", "IP": "192.192.192.192" }
The response:
{ "Status": "Successfully", "Exception": Null, "ClickID": 765, "AffiliateID": 15, "AdvertiserID": 18, "CoockiePeriod": 60, "RewardID": "Action", "RewardActionID": "SignUp" }
List of request parameters
AffiliateID (int) (required)
The affiliate ID from the URL query string
AdID (int) (required)
The ad ID from the URL query string
Tracker (string)
Tracking parameter for the affiliate
IP (string)
The customer's IP address.
List of response parameters
Status (enum)
is an indication of the success or failure of the operation. Possible values:
Successfully
Failed
Exception (string)
appears only in case of failure and contains details of the fault. Possible errors:
The authorization not exist!
The authorization is empty!
The authorization is invalid (Ad)!
The authorization is invalid (ApiKey)!
General error!
ClickId (int)
The unique click ID that referred you.
AffiliateID (int)
The unique partner ID that referred you.
AdvertiserID (int)
The unique Advertiser ID (Your ID).
CoockiePeriod (int)
Duration of the cookie. The time the user has from the moment of clicking until the conversion is performed.
RewardID (enum)
Type of reward. Possible values:
Click
Action
Sale
RewardActionID (enum)
Type of action. Possible values:
SignUp
SignUpEmailVerification
AppInstall
PhoneCall
ContactForm
FreeTrial
Nothing
Download
Lead
Find below the explanation how to report a Related Action:
POST:
/api/v1/createclickadditionalinfo
Host:
https://www.ironclick.net
Content-Type:
application/json
Authorization:
{Put your api key}
The request:
{ "ClickID": 306, "AffiliateID": 14, "AdvertiserID": 27, "RewardID": "Action", "RewardActionID": "ContactForm", "Value": 1, "CurrencyID": "ILS", "IP": "192.192.192.192" }
The response:
{ "Status": "Successfully", "CampaignID": 107, "AffiliateID": 14, "AdvertiserID": 27, "AdID": 58, "RewardID": "Action", "RewardActionID": "ContactForm", "Value": 1, "CurrencyID": "ILS" }
List of request parameters
ClickId (int) (required)
The unique click ID that referred you.
AffiliateID (int) (required)
The unique partner ID that referred you.
AdvertiserID (int) (required)
The unique Advertiser ID (Your ID).
RewardID (enum) (required)
Type of reward. Possible values:
Action
Sale
AutoRenewal
RewardActionID (enum)
Type of action. Possible values:
SignUp
SignUpEmailVerification
AppInstall
PhoneCall
ContactForm
FreeTrial
Nothing
Download
Lead
Value (decimal) (required)
The action value or number of actions. On a "sale" action enter the purchase amount. In every other action, enter the value 1 (unless you want to report multiple actions).
CurrencyID (enum)
The type of currency in which the payment was made on your site. This field must be entered only if you receive payments in different currencies and the type of transaction currency is different from the type of currency that is updated in your account. Possible values:
ILS
USD
EUR
IP (string)
The customer's IP address.
List of response parameters
Status (enum)
is an indication of the success or failure of the operation. Possible values:
Successfully
Failed
Exception (string)
appears only in case of failure and contains details of the fault. Possible errors:
The authorization not exist!
The authorization is empty!
The authorization is invalid (Click)!
The authorization is invalid (URL)!
The authorization is invalid (ApiKey)!
General error!
AffiliateID (int)
The unique partner ID that referred you.
AdvertiserID (int)
The unique Advertiser ID (Your ID).
RewardID (enum) (required)
Type of reward. Possible values:
Action
Sale
AutoRenewal
RewardActionID (enum)
Type of action. Possible values:
SignUp
SignUpEmailVerification
AppInstall
PhoneCall
ContactForm
FreeTrial
Nothing
Download
Lead
CampaignID (int)
The unique campaign ID in which the activity was made.
AdID (int)
The unique ad ID that referred you.
Value (decimal)
The action value or number of actions. On a "sale" action enter the purchase amount. In every other action, enter the value 1 (unless you want to report multiple actions).Please note - if you already send us the SUM parameter when reporting a conversion, then you don't need to report a related action of type "sale" because the information is already saved with us. Double report will result in incorrect data.
CurrencyID (enum)
The type of currency in which the payment was made on your site. This field must be entered only if you receive payments in different currencies and the type of transaction currency is different from the type of currency that is updated in your account. Possible values:
ILS
USD
EUR
Find below the explanation how to remove a Related Action:
POST:
/api/v1/removeclickadditionalinfo
Host:
https://www.ironclick.net
Content-Type:
application/json
Authorization:
{Put your api key}
The request:
{ "ClickID": 306, "AffiliateID": 14, "AdvertiserID": 27, "RewardID": "Action", "RewardActionID": "ContactForm", "Value": 1, "CurrencyID": "ILS", "IP": "192.192.192.192" }
The response:
{ "Status": "Successfully", "CampaignID": 107, "AffiliateID": 14, "AdvertiserID": 27, "AdID": 58, "RewardID": "Action", "RewardActionID": "ContactForm", "Value": 1, "CurrencyID": "ILS" }
List of request parameters
ClickId (int) (required)
The unique click ID that referred you.
AffiliateID (int) (required)
The unique partner ID that referred you.
AdvertiserID (int) (required)
The unique Advertiser ID (Your ID).
RewardID (enum) (required)
Type of reward. Possible values:
Action
Sale
AutoRenewal
RewardActionID (enum)
Type of action. Possible values:
SignUp
SignUpEmailVerification
AppInstall
PhoneCall
ContactForm
FreeTrial
Nothing
Download
Lead
Value (decimal) (required)
The action value or number of actions. On a "sale" action enter the purchase amount. In every other action, enter the value 1 (unless you want to report multiple actions).
CurrencyID (enum)
The type of currency in which the payment was made on your site. This field must be entered only if you receive payments in different currencies and the type of transaction currency is different from the type of currency that is updated in your account. Possible values:
ILS
USD
EUR
IP (string)
The customer's IP address.
List of response parameters
Status (enum)
is an indication of the success or failure of the operation. Possible values:
Successfully
Failed
Exception (string)
appears only in case of failure and contains details of the fault. Possible errors:
The authorization not exist!
The authorization is empty!
The authorization is invalid (Click)!
The authorization is invalid (URL)!
The authorization is invalid (ApiKey)!
The clickadditionalinfo not exist!
General error!
AffiliateID (int)
The unique partner ID that referred you.
AdvertiserID (int)
The unique Advertiser ID (Your ID).
RewardID (enum) (required)
Type of reward. Possible values:
Action
Sale
AutoRenewal
RewardActionID (enum)
Type of action. Possible values:
SignUp
SignUpEmailVerification
AppInstall
PhoneCall
ContactForm
FreeTrial
Nothing
Download
Lead
CampaignID (int)
The unique campaign ID in which the activity was made.
AdID (int)
The unique ad ID that referred you.
Value (decimal)
The action value or number of actions. On a "sale" action enter the purchase amount. In every other action, enter the value 1 (unless you want to report multiple actions).Please note - if you already send us the SUM parameter when reporting a conversion, then you don't need to report a related action of type "sale" because the information is already saved with us. Double report will result in incorrect data.
CurrencyID (enum)
The type of currency in which the payment was made on your site. This field must be entered only if you receive payments in different currencies and the type of transaction currency is different from the type of currency that is updated in your account. Possible values:
ILS
USD
EUR
Find below the explanation how to create a conversion:
POST:
/api/v1/createconversion
Host:
https://www.ironclick.net
Content-Type:
application/json
Authorization:
{Put your api key}
The request:
{ "ClickID": 457, "AffiliateID": 15, "AdvertiserID": 18, "Sum": 140.00, "CurrencyID": "ILS", "CustomerID": "343A", "Custom": "Custom information", "IP": "192.192.192.192" }
The response:
{ "Status": "Successfully", "Exception": Null, "ConversionID": 542, "CampaignID": 43, "AffiliatorID": 15, "AdvertiserID": 18, "AdID": 34, "RewardRate": 30.00, "CurrencyID": "ILS", "AdTypeID": "Link" }
List of request parameters
ClickId (int) (required)
The unique click ID that referred you.
AffiliateID (int) (required)
The unique partner ID that referred you.
AdvertiserID (int) (required)
The unique Advertiser ID (Your ID).
Sum (decimal?) (required only when percentage commission type)
The payment amount of the transaction on your site. It is mandatory to enter this field only if the reward in your campaign is according to a percentage of the transaction amount.
CurrencyID (enum)
The type of currency in which the payment was made on your site. This field must be entered only if you receive payments in different currencies and the type of transaction currency is different from the type of currency that is updated in your account. Possible values:
ILS
USD
EUR
CustomerID (string)
Customer ID on your site. Maximum 100 characters. Optional.
Custom (string)
Your own custom parameter. Maximum 1000 characters. Optional.
IP (string)
The customer's IP address.
List of response parameters
Status (enum)
is an indication of the success or failure of the operation. Possible values:
Successfully
Failed
Exception (string)
appears only in case of failure and contains details of the fault. Possible errors:
The authorization not exist!
The authorization is empty!
The authorization is invalid (Click)!
The authorization is invalid (ApiKey)!
The authorization is invalid (AffiliatorToCampaign)!
The Sum is required field!
General error!
ConversionID (int)
The unique conversion ID.
CampaignID (int)
The unique campaign ID in which the conversion was made.
AffiliateID (int)
The unique partner ID that referred you.
AdvertiserID (int)
The unique Advertiser ID (Your ID).
AdID (int)
The unique ad ID that referred you.
RewardRate (decimal?)
The commission rate you pay for the conversion.
CurrencyID (enum)
The currency type of the commission rate. Possible values:
ILS
USD
EUR
AdTypeID (enum)
The type of ad that referred you. Possible values:
Banner
Popup
Link
Find below the explanation how to reject a conversion:
POST:
/api/v1/rejectconversion
Host:
https://www.ironclick.net
Content-Type:
application/json
Authorization:
{Put your api key}
The request:
{ "ConversionID": 8, "ReasonID": "Fraud", "IP": "192.192.192.192" }
The response:
{ "Status": "Successfully", "Exception": Null }
List of request parameters
ConversionID (int) (required)
The unique conversion ID.
ReasonID (enum) (required)
Reason for postponement. Possible values:
Fake
NotVerified
NoResponse
Minor
Duplicated
IllegalActivity
Spam
Fraud
Canceled
WrongDetails
Other
Irrelevant
Refund
Error
IP (string)
The customer's IP address.
List of response parameters
Status (enum)
is an indication of the success or failure of the operation. Possible values:
Successfully
Failed
Exception (string)
appears only in case of failure and contains details of the fault. Possible errors:
The authorization not exist!
The authorization is empty!
The authorization is invalid (Conversion)! The authorization is invalid (Status)!
The authorization is invalid (ApiKey)!
The ReasonID is invalid!
You have passed the maximum number of rejections!
General error!
The authorization not exist!
In the header of the received request there is no key called Authorization.
The authorization is empty!
The received Authorization key does not contain any value.
The authorization is invalid (ApiKey)!
The Authorization key received is incorrect.
The authorization is invalid (Ad)!
There is no ad that matches the data received in the request.
The authorization is invalid (Click)!
There is no click that matches the data received in the request.
The authorization is invalid (AffiliatorToCampaign)!
According to data received in the request, the affiliate is not identified with the campaign.
The authorization is invalid (Conversion)!
There is no conversion that matches the data received in the request.
The authorization is invalid (Status)!
Changed conversion status pending approval.
The Sum is required field!
The amount of the transaction must be transferred in case the commission type of the campaign is percentage.
The ReasonID is invalid!
The received rejection reason value is not correct.
You have passed the maximum number of rejections!
You have exceeded the maximum number of rejections.
The clickadditionalinfo not exist!
There is no compatible related action according to the data sent.
General error!
General error.