Affiliate Network Web Service
A Web Service is a software system designed to support interoperable Machine to Machine interaction over a network. Some Affiliate Network had already develop them own Web Services as well as Web APIs, but anthers not. So we develop this Open-Source program to get the essential data from the Affiliate Network webpage and output as a XML file, allows you easy sync affiliate programs status, payout, links, creatives, banners ant statistics.
How This API Work
This program works very simple, it claw the affiliate network webpages by your own account details and process the HTML page to a XML package. So you need provide your own username and password for use this program, that's why this program is Open-Source and need you install into your own computer or own server, otherwise will nobody dare to use it.
Problems?
Ya, most big problem is these affiliate networks did not provide them own Web Services. However, we cannot solve that. For the problem of this program, as you can see, it claw webpages and process HTML code, so it will stop work if the affiliate network change them program too much. If this happen, we will update our code, you just need download a new one. Btw, this program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY.
Much Much More
Here is the list of Affiliate Networks we are working with, except some of networks already have them own Web Services API, we will develop the SOAP interface for all other networks.
Contact
Please send us for any queries or suggestions.
InfoSmith Affiliate Network Web Services
Welcome, affiliate marketing experts, we share this program for make our life more easier. Here is what's this program use for:
Our program gives you Well formatted XML file by your affiliate account situation. Currently, we support these affiliate networks:
* Still to come: Shareasale, clixGalore, Kolimbo and more. Click here check all affiliate networks we are working with.
Install
This program is a lightweight code, will easily work on IIS, from Windows 2000, XP, 2003 to Vista. If you have problem of WinHTTP, you only need download a new version of WinHTTP from Microsoft.
Steps:
- Make a folder in your IIS website, for example, make a folder call "infosmith" at your http://localhost/
- Download all files list on right hand side and save into the folder you created
- Done
Update
Update is easy, simply download the new files and overwrite the old files.
Settings
In most of case, you do not need setup anything. All settings need write into setting.asp file in your folder. The setting file do not need update, so all your settings won't be overwrite.
How? If you do not know ASP/VBScript language, here is the basic: Write the setting between <% and %>, in it's own line as format "Setting = Value", for example: SettingScriptTimeout = 300. For string value, put an double quote mark on each side, example: SettingProxyServer = "127.0.0.1".
Setup Username and Password for Affiliate Network
Please note, you do not need write down your username and password in the setting file, you can submit your username and password by POST or GET method. These settings are design for some case may people need.
- SettingAffiliatefutureUsername and SettingAffiliatefuturePassword for Affiliate Future
- SettingPaidonresultsUsername and SettingPaidonresultsPassword for Paid On Results
- SettingPepperjamNetworkUsername and SettingPepperjamNetworkPassword for pepperjamNETWORK
- SettingPerformicsUsername and SettingPerformicsPassword for DoubleClick Performics
Timeout Settings
If your computer or network slow, you can write in these settings.
- SettingScriptTimeout: specifies the maximum amount of time in seconds can run before the program is terminated, default value 300 seconds
- SettingHTTPResolveTimeout: Time-out value applied when resolving a host name to an IP address, in milliseconds. The default value is 10,000 (10 seconds)
- SettingHTTPConnectTimeout: Time-out value applied when establishing a communication socket with the target server, default value is 10,000 (10 seconds)
- SettingHTTPSendTimeout: Time-out value applied when sending an individual packet of request data on the communication socket to the target servers. The default value is 120,000 (120 seconds)
- SettingHTTPReceiveTimeout: Time-out value applied when receiving a packet of response data from the target server, default value is 60,000 (60 seconds)
Proxy Server
If your need use proxy server connect to internet, please use this setting.
- SettingProxyNeed: specifies need proxy server or not, value is True or False, default is False
- SettingProxyServer: your proxy server, an IP or a domain
- SettingProxyPort: the port of proxy server
- SettingProxyUser: if your proxy server need login, put username here
- SettingProxyPass: if your proxy server need login, put password here
Howto Use, Howto get XML File
We are not use SOAP, the Simple Object Access Protocol, we only need the simple HTTP. You get XML file by visit an URL, same like visit a website. For example your install the code in infosmith folder of your localhost website. So, you need visit: http://localhost/infosmith/index.asp. If success, you can see a XML file open in your browser and ask you provide required parameter.
Here is the parameters you can use:
- Network
- Currently we support AffiliateFuture, PaidOnResults, pepperjamNETWORK and GoogleAffiliate (or Performics), case sensitive
- Task
- Details, Creative, Commission and Product, case sensitive, please note not all Network support each Task
- Username
- Password
- The username and password for current Network, you can use POST or GET method, if you setup username and password in setting.asp file, you can ignore these two parameters
- ProgramID
- The affiliate program ID in the current Network.
- DateFrom
- DateTo
- need when Commission Task, format is YYYY-MM-DD, e.g. 2008-1-31
- Page
- PageSize
- indicate current Page and PageSize, default Page 1 and PageSize is 10
Example:
XML Node Definition
Task: Details
<?xml version="1.0" encoding="utf-8" ?>
<InfoSmith>
<Program>
<ProgramNetwork></ProgramNetwork>
<ProgramID></ProgramID>
<ProgramName></ProgramName>
<ProgramDescription></ProgramDescription>
<ProgramIntroduction></ProgramIntroduction>
<ProgramCatalog></ProgramCatalog>
<ProgramKeyword></ProgramKeyword>
<ProgramCountry></ProgramCountry>
<ProgramWebsite>
<ProgramWebsiteUrl></ProgramWebsiteUrl>
</ProgramWebsite>
<ProgramUrl></ProgramUrl>
<ProgramLogo>
<ProgramLogoUrl></ProgramLogoUrl>
<ProgramLogoWidth></ProgramLogoWidth>
<ProgramLogoHeight></ProgramLogoHeight>
</ProgramLogo>
<ProgramStatus></ProgramStatus>
<ProgramCommission>
<ProgramCommissionCurrency></ProgramCommissionCurrency>
<ProgramCommissionSale></ProgramCommissionSale>
<ProgramCommissionLead></ProgramCommissionLead>
</ProgramCommission>
</Program>
<Result>
<ResultTotal></ResultTotal>
<ResultCurrent></ResultCurrent>
<ResultPageTotal></ResultPageTotal>
<ResultPageCurrent></ResultPageCurrent>
<ResultPerPage></ResultPerPage>
</Result>
</InfoSmith>
Task: Creative
<?xml version="1.0" encoding="utf-8" ?>
<InfoSmith>
<Program>
<ProgramNetwork></ProgramNetwork>
<ProgramID></ProgramID>
<ProgramName></ProgramName>
</Program>
<Creative>
<CreativeName></CreativeName>
<CreativeType></CreativeType>
<CreativeDescription></CreativeDescription>
<CreativeUrl></CreativeUrl>
<CreativeDate>
<CreativeDateStart></CreativeDateStart>
<CreativeDateEnd></CreativeDateEnd>
<CreativeDateUpdate></CreativeDateUpdate>
</CreativeDate>
<CreativeElement>
<CreativeElementType></CreativeElementType>
<CreativeElementAbsoluteUrl></CreativeElementAbsoluteUrl>
<CreativeElementTrackingUrl></CreativeElementTrackingUrl>
</CreativeElement>
<CreativeWidth></CreativeWidth>
<CreativeHeight></CreativeHeight>
<CreativeCode>
<CreativeCodeHtml></CreativeCodeHtml>
</CreativeCode>
</Creative>
<Result>
<ResultTotal></ResultTotal>
<ResultCurrent></ResultCurrent>
<ResultPageTotal></ResultPageTotal>
<ResultPageCurrent></ResultPageCurrent>
<ResultPerPage></ResultPerPage>
</Result>
</InfoSmith>
Task: Commission
<?xml version="1.0" encoding="utf-8" ?>
<InfoSmith>
<Commission>
<CommissionProgramID></CommissionProgramID>
<CommissionProgramName></CommissionProgramName>
<CommissionTime></CommissionTime>
<CommissionID></CommissionID>
<CommissionCurrency></CommissionCurrency>
<CommissionAmount></CommissionAmount>
<CommissionStatus></CommissionStatus>
<CommissionCountry></CommissionCountry>
</Commission>
<Result>
<ResultTotal></ResultTotal>
<ResultCurrent></ResultCurrent>
<ResultPageTotal></ResultPageTotal>
<ResultPageCurrent></ResultPageCurrent>
<ResultPerPage></ResultPerPage>
</Result>
</InfoSmith>
Task: Product
<?xml version="1.0" encoding="utf-8" ?>
<InfoSmith>
<Program>
<ProgramNetwork></ProgramNetwork>
<ProgramID></ProgramID>
<ProgramName></ProgramName>
</Program>
<Product>
<ProductID></ProductID>
<ProductName></ProductName>
<ProductDescription></ProductDescription>
<ProductUrl>
<ProductUrlTracking></ProductUrlTracking>
<ProductUrlPage></ProductUrlPage>
</ProductUrl>
<ProductStock>
<ProductStockStatus></ProductStockStatus>
<ProductStockQuantity></ProductStockQuantity>
</ProductStock>
<ProductManufactory>
<ProductManufactoryName></ProductManufactoryName>
<ProductManufactoryBrand></ProductManufactoryBrand>
<ProductManufactoryCode></ProductManufactoryCode>
</ProductManufactory>
<ProductCodes>
<ProductCode></ProductCode>
</ProductCodes>
<ProductPrice>
<ProductPriceCurrency></ProductPriceCurrency>
<ProductPriceMarket></ProductPriceMarket>
<ProductPriceSelling></ProductPriceSelling>
</ProductPrice>
<ProductPictures>
<ProductPicture>
<ProductPictureUrl></ProductPictureUrl>
<ProductPictureWidth></ProductPictureWidth>
<ProductPictureHeight></ProductPictureHeight>
</ProductPicture>
</ProductPictures>
</Product>
<Result>
<ResultTotal></ResultTotal>
<ResultCurrent></ResultCurrent>
<ResultPageTotal></ResultPageTotal>
<ResultPageCurrent></ResultPageCurrent>
<ResultPerPage></ResultPerPage>
</Result>
</InfoSmith>
Error Messages
Common Errors
- 0000-0001
- Please provide required parameter "Network".
- 0000-0002
- Unknown affiliate network "????", please note "Network" parameter is case sensitive.
- 0000-0003
- Please provide required parameters "Username" and "Password", you can submit these two parameters by either GET or POST method.
- 0000-0004
- Please provide required parameter "Task".
- 0000-1101
- You provided wrong format of "DateFrom" parameter.
The parameters "DateFrom" and "DateTo" are using for indicate date range, the format is "YYYY-MM-DD", e.g. "2008-1-30". Please note the "From Date" should not later than the "To Date".
- 0000-1102
- You provided wrong format of "DateTo" parameter.
The "DateFrom" and "DateTo" parameters are using for indicate date range, the format is "YYYY-MM-DD", e.g. "2008-1-30". Please note the "From Date" should not later than the "To Date".
- 0000-1103
- You provided wrong format of "Page" parameter.
The "Page" parameter is using for indicate current listing page for multiple pages output, it is a positive integer.
- 0000-1104
- You provided wrong format of "PageSize" parameter.
The "PageSize" parameter is using for setup the item number in one page, it is a positive integer, between 10 and 100.
- 0000-1111
- No data received. It may caused by Network Error or Program Not Exist.
- 0000-1112
- Uncompleted data received. Please try again.
- 0000-2222
- Endless Loop
Login Session or Cookie keep lost, please ask administrator to check this program.
FAQ
Who need this program?
Everyone involved into Affiliate Business need sync them data, for Affiliate Marketing Experts, manage huge affiliate programs is a tough task. Therefore, web services, so call API introduced for make things easier by sync data by program itself. But unfortunately, not all great affiliate networks provide APIs. So you need this program sync the data for the networks without webservices.
I want to know more
Please email us (
), we like to hear from you.
Program Files
Please download the new files and overwrite the old files, for first time install, you need download all files.
Index File (index.asp)
Main file for all affiliate networks, general process.
Affiliate Future (affiliatefuture.asp)
Web Services API function file for Affiliate Future Affiliate Network. If you do not have account for this network,
Click Here Apply.
Google Affiliate Network (performics.asp)
Web Services API function file for Google Affiliate Network (former DoubleClick Performics Affiliate Network).
Market Health (markethealth.asp)
Web Services API function file for Market Health Affiliate Network (former JoeBucks Affiliate Program). If you do not have account for this network,
Click Here Apply.
Paid On Results (paidonresults.asp)
Web Services API function file for Paid On Results Affiliate Network. If you do not have account for this network,
Click Here Apply.
pepperjamNETWORK (pepperjamnetwork.asp)
Web Services API function file for Pepperjam Affiliate Network.
Setting File (setting.asp)
Setting file, an empty ASP file, you do not need download this file again once you installed.