Design
1.1 API Category
Network Offer API
|
Create / Modify / Query Offer
|
Network Affiliate API
|
Create / Modify / Query Affiliate
|
Network Advertiser API
|
Create / Modify / Query Advertiser
|
Network Campaign API
|
Get / Generate Tracking Link for Affiliate
|
Network Report API
|
Get Report Data.
|
1.2 API Method List
No.
|
Category
|
Method
|
Description
|
1.
|
Network Offer API |
getOffers
|
Get Offer By Status、Create Date
|
2.
|
getOfferById
|
Get Offer Details By Offer ID
|
|
3.
|
getOfferCategories
|
Get Offer Categories list
|
|
4.
|
getCategoryOffers
|
Get Offers in particular Category
|
|
5.
|
addCategoryOffers
|
Add Offers to the Category
|
|
6.
|
delCategoryOffers
|
Remove Offers from the Category
|
|
7.
|
getTrafficTypes
|
Get Offer on Traffic Types specification
|
|
8.
|
getOfferGeoGroups
|
Get Offer GEO Groups
|
|
9.
|
setOfferBaseInfo
|
Set Offer Base Info, if not exist, Create it.
|
|
10.
|
setOfferTierPayoutInfo
|
Set Up an Offer on Payout Tiers
|
|
11.
|
setOffeCapInfo
|
Set Up an Offer on CAP Rules
|
|
12.
|
setOfferGeoInfo
|
Set Up an Offer on GEO Targeting Rules
|
|
13.
|
setOfferDeviceInfo
|
Set Up an Offer on Device Targeting Rules
|
|
14.
|
getOffersByAdvertiserId
|
Get Offer By Advertiser ID
|
|
15.
|
getOffersByManagerId
|
Get Offer By Advertiser Manager ID
|
|
16.
|
setOfferEventBaseInfo
|
Set Offer Event Base Info, if not exist, Create it.
|
|
17.
|
getOfferAffiliateList
|
Get the approved affiliat list or the blocked affiliate list with the specific offer.
|
|
18.
|
setOfferAffiliateList
|
Set the approved affiliat list or the blocked affiliate list with the specific offer
|
|
19.
|
getOfferApplicationList
|
Get the offer application list.
|
|
20.
|
changeOfferApplicationStatus
|
Processing the offer application.
|
|
21.
|
Network Affiliate API |
getAffiliates
|
Get a list of Affiliates By Status
|
22.
|
getAffiliateById
|
Get Affiliate Details By Affiliate ID
|
|
23.
|
getAffiliateManagers
|
Get a list of Affiliate Managers
|
|
24.
|
getPayoutTiers
|
Get info of Payout Tiers
|
|
25.
|
setAffiliateBaseInfo
|
Set Affiliate Base Info, if not exist, Create it.
|
|
26.
|
setAffiliatePaymentInfo
|
Set up an Affiliate’s Payment Info
|
|
27.
|
getAffiliatePostBacks
|
Get Global Post Back URLs of an Affiliate
|
|
28.
|
addAffiliatePostBack
|
Add a Global Post Back URL for Affiliate
|
|
29.
|
delAffiliatePostBack
|
Delete Affiliate Global Post Back URL
|
|
30.
|
getAffiliateEventPostBacks
|
Get all event post back URLs from the affiliate.
|
|
31.
|
addAffiliateEventPostBack
|
Add post back URL for an offer event with an affiliate.
|
|
32.
|
delAffiliateEventPostBack
|
Delete post back URL of an offer event with an affiliate.
|
|
33.
|
Network Advertiser API |
getAdvertisers
|
Get a list of Advertiser ranked by status
|
34.
|
getAdvertiserById
|
Get Advertiser Details by ID
|
|
35.
|
getAdvertiserManagers
|
Get a list of Advertiser Managers
|
|
36.
|
setAdvertiser
|
Set Advertiser, if not exist, Create it
|
|
37.
|
Network
Campaign API |
generateLink
|
Generate Link from Affiliate ID and Offer ID
|
38.
|
getLink
|
Get Link by Affiliate ID and Offer ID
|
|
39.
|
Network Report API |
getAdvertiserReport
|
Get Advertiser Report Data
|
40.
|
getOfferReport
|
Get Offer Report Data
|
|
41.
|
getAffiliateReport
|
Get Affiliate Report Data
|
|
42.
|
getOverallReport
|
Get Overall Report Data
|
|
43.
|
getConversionReport
|
Get Conversion Report Data
|
1.3 API Process Flow Order
1) Verify Key;
2) Verify Network ( and Affiliate);
3) Verify the IP address list of Network;
4) Verify Access Frequency;
5) Verify Method;
6) Filtering Parameters;
7) Perform Action;
8) Generate Response and Return.
1.4 Response
1.4.1 Response Status
Category
|
Status Code
|
Description
|
Success |
200
|
OK
|
201
|
Created
|
|
202
|
Accepted
|
|
Client Error |
400
|
Bad Request
|
401
|
Unauthorized
|
|
403
|
Forbidden
|
|
404
|
Not Found
|
|
405
|
Method not Allowed
|
|
409
|
Conflict
|
|
429
|
Too Many Requests
|
|
Server Error |
500
|
Internal Server Error
|
502
|
Bad Gateway
|
|
503
|
Service Unavailable
|
|
504
|
Gateway Timeout
|
1.4.2 General Validation
Object
|
Description
|
Response HTTP Status Code
|
Key
|
No API Key
Invalid API Key |
400
|
Key
|
Invalid API Key Status
|
403
|
IP
|
IP Not Match
|
403
|
Network
|
Invalid Network Status
|
403
|
API Method
|
No API Method
API Method Not Exist |
400
|
Request Method
|
Request Method Not Allowed
|
405
|
Access Frequency
|
Too Many API Request
|
429
|
1.4.3 Response Contents
Fuseclick encode API response contents in JSON format.
Data Field
|
Description
|
httpStatus
|
Same as Response HTTP Status
|
data
|
Data, Object or Array
|
errorCode
|
Exception Details Code
|
message
|
Exception Message
|
Close All
API V3
API V2
-
User - Network
-
User - Affiliate
-
Offer
-
Report
-
Dictionary
API V1 (DEPRECATED)