ממשק Rest API של IronClick מאפשר לך לשלוח ולקבל דיווחים על פעולות בקמפיינים שלך.
ה - API משתמש בסטנדרט HTTP אשר מקבל בקשות ומחזיר תשובות מקודדות JSON.

להלן הפעולות שניתן לבצע באמצעות ה - API:
הקלקה – דיווח של הקלקה על מודעה בקמפיין שלך.
המרה - דיווח על ביצוע המרה בקמפיין שלך.
פסילה – פסילה של המרה באחד הקמפיינים שלך.
מידע – פעולות שונות שמספקות תובנות אודות אפקטיביות הקמפיין.

הערה
ממשק ה - API אינו חובה אך מומלץ כצורת ההתממשקות המועדפת.
באפשרותך להתממשק בצורה פשוטה יותר גם באמצעות הטמעת קוד javascript באתר.
ראה פרטים נוספים בעניין (ואפשרות לבצע טסטים) בהגדרות הקמפיין שלך.

בכל פניה לשרת של איירון קליק אנו צריכים לאמת שהפניה אכן הגיע ממך, לכן חובה להעביר ב - Header של הפניה, פרמטר Authorization אשר מכיל את ה API KEY האישי שלך.

להלן ההסבר על אופן יצירת הקלקה:
POST:
/api/v1/createclick
Host:
https://www.ironclick.net
Content-Type:
application/json
Authorization:
{Put your api key}
הבקשה:
{ "AffiliateID": 15, "AdID": 34, "Tracker": "tracker", "IP":"192.192.192.192" }
התגובה:
{ "Status": "Successfully", "Exception": Null, "ClickID": 765, "AffiliateID": 15, "AdvertiserID": 18, "CoockiePeriod": 60, "RewardID": "Action", "RewardActionID": "SignUp" }
רשימת פרמטרים של הבקשה
AffiliateID (int) (חובה)
מזהה השותף ממחרוזת שאילתת כתובת האתר
AdID (int) (חובה)
מזהה המודעה ממחרוזת שאילתת כתובת האתר
Tracker (string)
פרמטר מעקב עבור השותף
IP (string)
כתובת האיי.פי של הלקוח.
רשימת פרמטרים של התגובה
Status (enum)
מהווה אינדיקציה לגבי הצלחה או כישלון של הפעולה. הערכים אפשריים:
Successfully
Failed
Exception (string)
מופיע רק בעת כישלון ומכיל פירוט של התקלה. השגיות אפשריות:
The authorization not exist!
The authorization is empty!
The authorization is invalid (Ad)!
The authorization is invalid (ApiKey)!
General error!
ClickId (int)
מזהה הקליק הייחודי שהפנה אליך
AffiliateID (int)
מזהה השותף הייחודי שהפנה אליך
AdvertiserID (int)
מזהה המפרסם הייחודי (המזהה שלך)
CoockiePeriod (int)
משך זמן העוגייה. הזמן שיש לגולש מרגע ההקלקה ועד לביצוע ההמרה
RewardID (enum)
סוג תגמול. הערכים אפשריים:
Click
Action
Sale
RewardActionID (enum)
סוג פעולה. הערכים אפשריים:
SignUp
SignUpEmailVerification
AppInstall
PhoneCall
ContactForm
FreeTrial
Nothing
Download
Lead
להלן הסבר על אופן יצירת פעולה משלימה:
POST:
/api/v1/createclickadditionalinfo
Host:
https://www.ironclick.net
Content-Type:
application/json
Authorization:
{Put your api key}
הבקשה:
{ "ClickID": 306, "AffiliateID": 14, "AdvertiserID": 27, "RewardID": "Action", "RewardActionID": "ContactForm", "Value": 1, "CurrencyID": "ILS", "IP": "192.192.192.192" }
התגובה:
{ "Status": "Successfully", "CampaignID": 107, "AffiliateID": 14, "AdvertiserID": 27, "AdID": 58, "RewardID": "Action", "RewardActionID": "ContactForm", "Value": 1, "CurrencyID": null }
רשימת פרמטרים של הבקשה
ClickId (int) (חובה)
מזהה הקליק הייחודי שהפנה אליך.
AffiliateID (int) (חובה)
מזהה השותף ממחרוזת שאילתת כתובת האתר
AdvertiserID (int) (חובה)
מזהה המפרסם הייחודי (המזהה שלך).
RewardID (enum) (חובה)
סוג תגמול. הערכים אפשריים:
Action
Sale
AutoRenewal
RewardActionID (enum)
סוג פעולה. הערכים אפשריים:
SignUp
SignUpEmailVerification
AppInstall
PhoneCall
ContactForm
FreeTrial
Nothing
Download
Lead
Value (decimal) (חובה)
ערך הפעולה או מספר הפעולות. בפעולה מסוג מכירות יש להזין את סכום המכירה. בכל פעולה אחרת יש להזין את הערך 1 (אלא אם כן אתה רוצה לדווח על מספר פעולות במרוכז).
CurrencyID (enum)
סוג המטבע בו בוצע התשלום באתר שלך .חובה להזין שדה זה רק אם אתה מקבל תשלומים במטבעות שונים וסוג מטבע העסקה שונה מסוג המטבע שמעודכן בחשבונך. הערכים אפשריים:
ILS
USD
EUR
IP (string)
כתובת האיי.פי של הלקוח.
רשימת פרמטרים של התגובה
Status (enum)
מהווה אינדיקציה לגבי הצלחה או כישלון של הפעולה. הערכים אפשריים:
Successfully
Failed
Exception (string)
מופיע רק בעת כישלון ומכיל פירוט של התקלה. השגיות אפשריות:
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)
מזהה השותף הייחודי שהפנה אליך
AdvertiserID (int)
מזהה המפרסם הייחודי (המזהה שלך)
RewardID (enum)
סוג תגמול. הערכים אפשריים:
Action
Sale
AutoRenewal
RewardActionID (enum)
סוג פעולה. הערכים אפשריים:
SignUp
SignUpEmailVerification
AppInstall
PhoneCall
ContactForm
FreeTrial
Nothing
Download
Lead
CampaignID (int)
מזהה הקמפיין הייחודי בו בוצעה הפעולה.
AdID (int)
מזהה המודעה הייחודי שהפנתה אליך.
Value (decimal)
ערך הפעולה או מספר הפעולות. בפעולה מסוג מכירות יש להזין את סכום המכירה. בכל פעולה אחרת יש להזין את הערך 1 (אלא אם כן אתה רוצה לדווח על מספר פעולות במרוכז). שים לב – אם בעת דיווח על המרה אתה כבר שולח לנו את הפרמטר SUM אז לא לשלוח דיווח נוסף על פעולה משלימה מסוג "מכירה" כי המידע כבר שמור אצלנו ודיווח כפול יגרום לנתונים שגויים.
CurrencyID (enum)
סוג המטבע בו בוצע התשלום באתר שלך .חובה להזין שדה זה רק אם אתה מקבל תשלומים במטבעות שונים וסוג מטבע העסקה שונה מסוג המטבע שמעודכן בחשבונך. הערכים אפשריים:
ILS
USD
EUR
להלן הסבר על אופן מחיקה פעולה משלימה:
POST:
/api/v1/removeclickadditionalinfo
Host:
https://www.ironclick.net
Content-Type:
application/json
Authorization:
{Put your api key}
הבקשה:
{ "ClickID": 306, "AffiliateID": 14, "AdvertiserID": 27, "RewardID": "Action", "RewardActionID": "ContactForm", "Value": 1, "CurrencyID": null, "IP": "192.192.192.192" }
התגובה:
{ "Status": "Successfully", "CampaignID": 107, "AffiliateID": 14, "AdvertiserID": 27, "AdID": 58, "RewardID": "Action", "RewardActionID": "ContactForm", "Value": 1, "CurrencyID": null }
רשימת פרמטרים של הבקשה
ClickId (int) (חובה)
מזהה הקליק הייחודי שהפנה אליך.
AffiliateID (int) (חובה)
מזהה השותף ממחרוזת שאילתת כתובת האתר
AdvertiserID (int) (חובה)
מזהה המפרסם הייחודי (המזהה שלך).
RewardID (enum) (חובה)
סוג תגמול. הערכים אפשריים:
Action
Sale
AutoRenewal
RewardActionID (enum)
סוג פעולה. הערכים אפשריים:
SignUp
SignUpEmailVerification
AppInstall
PhoneCall
ContactForm
FreeTrial
Nothing
Download
Lead
Value (decimal) (חובה)
ערך הפעולה או מספר הפעולות. בפעולה מסוג מכירות יש להזין את סכום המכירה. בכל פעולה אחרת יש להזין את הערך 1 (אלא אם כן אתה רוצה לדווח על מספר פעולות במרוכז).
CurrencyID (enum)
סוג המטבע בו בוצע התשלום באתר שלך .חובה להזין שדה זה רק אם אתה מקבל תשלומים במטבעות שונים וסוג מטבע העסקה שונה מסוג המטבע שמעודכן בחשבונך. הערכים אפשריים:
ILS
USD
EUR
IP (string)
כתובת האיי.פי של הלקוח.
רשימת פרמטרים של התגובה
Status (enum)
מהווה אינדיקציה לגבי הצלחה או כישלון של הפעולה. הערכים אפשריים:
Successfully
Failed
Exception (string)
מופיע רק בעת כישלון ומכיל פירוט של התקלה. השגיות אפשריות:
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)
מזהה השותף הייחודי שהפנה אליך
AdvertiserID (int)
מזהה המפרסם הייחודי (המזהה שלך)
RewardID (enum)
סוג תגמול. הערכים אפשריים:
Action
Sale
AutoRenewal
RewardActionID (enum)
סוג פעולה. הערכים אפשריים:
SignUp
SignUpEmailVerification
AppInstall
PhoneCall
ContactForm
FreeTrial
Nothing
Download
Lead
CampaignID (int)
מזהה הקמפיין הייחודי בו בוצעה הפעולה.
AdID (int)
מזהה המודעה הייחודי שהפנתה אליך.
Value (decimal)
ערך הפעולה או מספר הפעולות. בפעולה מסוג מכירות יש להזין את סכום המכירה. בכל פעולה אחרת יש להזין את הערך 1 (אלא אם כן אתה רוצה לדווח על מספר פעולות במרוכז).
CurrencyID (enum)
סוג המטבע בו בוצע התשלום באתר שלך .חובה להזין שדה זה רק אם אתה מקבל תשלומים במטבעות שונים וסוג מטבע העסקה שונה מסוג המטבע שמעודכן בחשבונך. הערכים אפשריים:
ILS
USD
EUR
להלן ההסבר על אופן יצירת המרה:
POST:
/api/v1/createconversion
Host:
https://www.ironclick.net
Content-Type:
application/json
Authorization:
{Put your api key}
הבקשה:
{ "ClickID": 457, "AffiliateID": 15, "AdvertiserID": 18, "Sum": 140.00, "CurrencyID": "ILS", "CustomerID": "343A", "Custom": "Custom information", "IP": "192.192.192.192" }
התגובה:
{ "Status": "Successfully", "Exception": Null, "ConversionID": 542, "CampaignID": 43, "AffiliatorID": 15, "AdvertiserID": 18, "AdID": 34, "RewardRate": 30.00, "CurrencyID": "ILS", "AdTypeID": "Link" }
רשימת פרמטרים של הבקשה
ClickId (int) (חובה)
מזהה הקליק הייחודי שהפנה אליך.
AffiliateID (int) (חובה)
מזהה השותף הייחודי שהפנה אליך.
AdvertiserID (int) (חובה)
מזהה המפרסם הייחודי (המזהה שלך).
Sum (decimal?) (חובה רק כאשר סוג עמלה אחוזים)
סכום התשלום של העסקה באתר שלך. חובה להזין שדה זה רק אם התגמול בקמפיין שלך הוא לפי אחוז מסכום העסקה.
CurrencyID (enum)
סוג המטבע בו בוצע התשלום באתר שלך .חובה להזין שדה זה רק אם אתה מקבל תשלומים במטבעות שונים וסוג מטבע העסקה שונה מסוג המטבע שמעודכן בחשבונך. הערכים אפשריים:
ILS
USD
EUR
CustomerID (string)
מזהה הלקוח באתר שלך. מקסימום 100 תווים. לא חובה.
Custom (string)
פרמטר מותאם אישית משלך. מקסימום 1000 תווים. לא חובה.
IP (string)
כתובת האיי.פי של הלקוח.
רשימת פרמטרים של התגובה
Status (enum)
מהווה אינדיקציה לגבי הצלחה או כישלון של הפעולה. הערכים אפשריים:
Successfully
Failed
Exception (string)
מופיע רק בעת כישלון ומכיל פירוט של התקלה. השגיות אפשריות:
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)
מזהה ההמרה הייחודי.
CampaignID (int)
מזהה הקמפיין הייחודי בו בוצעה ההמרה.
AffiliateID (int)
מזהה השותף הייחודי שהפנה אליך.
AdvertiserID (int)
מזהה המפרסם הייחודי (המזהה שלך).
AdID (int)
מזהה המודעה הייחודי שהפנתה אליך.
RewardRate (decimal?)
תעריף העמלה שאתה משלם עבור ההמרה.
CurrencyID (enum)
סוג המטבע של תעריף העמלה. הערכים אפשריים:
ILS
USD
EUR
AdTypeID (enum)
סוג המודעה שהפנתה אליך. הערכים אפשריים:
Banner
Popup
Link
להלן ההסבר על אופן דחית המרה:
POST:
/api/v1/rejectconversion
Host:
https://www.ironclick.net
Content-Type:
application/json
Authorization:
{Put your api key}
הבקשה:
{ "ConversionID": 8, "ReasonID": "Fraud", "IP": "192.192.192.192" }
התגובה:
{ "Status": "Successfully", "Exception": Null }
רשימת פרמטרים של הבקשה
ConversionID (int) (חובה)
מזהה חד ערכי של המרה.
ReasonID (enum) (חובה)
סיבת הדחיה. הערכים אפשריים:
Fake
NotVerified
NoResponse
Minor
Duplicated
IllegalActivity
Spam
Fraud
Canceled
WrongDetails
Other
Irrelevant
Refund
Error
IP (string)
כתובת האיי.פי של הלקוח.
רשימת פרמטרים של התגובה
Status (enum)
מהווה אינדיקציה לגבי הצלחה או כישלון של הפעולה. הערכים אפשריים:
Successfully
Failed
Exception (string)
מופיע רק בעת כישלון ומכיל פירוט של התקלה. השגיות אפשריות:
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!
בכותרת של הבקשה שהתקבלה אין מפתח בשם Authorization.
The authorization is empty!
המפתח Authorization שהתקבל אינו מכיל שום ערך.
The authorization is invalid (ApiKey)!
המפתח Authorization שהתקבל אינו תקין.
The authorization is invalid (Ad)!
לא קיימת מודעה אשר תואמת לנתונים שהתקבלו בבקשה.
The authorization is invalid (Click)!
לא קיימת הקלקה אשר תואמת לנתונים שהתקבלו בבקשה.
The authorization is invalid (AffiliatorToCampaign)!
לפי נתונים שהתקבלו בבקשה השותף אינו מזוהה עם הקמפיין.
The authorization is invalid (Conversion)!
לא קיימת המרה אשר תואמת לנתונים שהתקבלו בבקשה.
The authorization is invalid (Status)!
סטטוס המרה שונה ממתין לאישור.
The Sum is required field!
כאשר בקמפיין סוג עמלה אחוזים חובה להעביר סכום העסקה.
The ReasonID is invalid!
ערך סיבת הדחיה שהתקבל אינו תקין.
You have passed the maximum number of rejections!
עברת את המספר המרבי של הדחיות.
The clickadditionalinfo not exist!
לא קיימת פעולה משלימה תואמת לפי הנתונים שנשלחו.
General error!
תקלה כללית.