HugOffers API Documents

Version 1.3.2

1. Introduction

This document will introduce HugOffers API (hereinafter referred to as API). Advanced partners can get campaign information by calling API.

HugOffers API is built on HTTP protocol, using GET / POST way to obtain the response content. Notably, to call our API, please contact with your account manager to get your API Key for authentication. Since anyone can conduct API request on your account’s behalf with the API Key, please keep your API Key confidential.

2. Get Campaign List

This interface will provide a list of promoted campaigns and all related information. The return value is a json.

Note:

This interface is case sensitive and you must distinguish campaigns by yourself.

2.1 Request

2.1.1 Parameter

Parameter	Description
token	An unique identify of the partner
cid	Customer id

2.1.2 URL Sample

http://{cid}.hoapi0.com/v1?cid={Customer_id}&token={Token}

Please contact with your account manager to get your unique request URL.

Note: Since we do API together, your account manager will NOT send you extra emails to notify you changes of campaigns. To avoid any unexpected loss, please conduct API request with a reasonable frequency. Any campaign modification will take effect in 24 hours starting from the time you get response from API.

2.2 Query

2.2.1 Params:

Params	Required	Desc
token	Yes	Unique key
cid	Yes	Customer id
page	No	Pagesize,current page.eg:page=10,1
return	No[json,xml]	Default json
expand	No[creatives]	Get creative link: ****&expand=creatives
geo	No	Filter by geo value,mult- geo should be implode by “,”,eg:geo=es,vn
id	No	Only show offer which campid=[id]
platform	No[android,iOS]	Default: all_device

Attention:

if the ID is set, request with other parameters will be ineffective.

2.3 Response

2.3.1 Parameters

Parameters	Description
total_offers_num	Total offers counts
max_page	Maximum page
page	Current page
offers_num_this_page	Rows of current page
success	true or false
offers	refer to offer data

2.3.2 Offer Data

Parameter	Description	Possible Value	Allow Multiple Value	Sample
campid	Campaign ID	int number	No	10
offer_name	Campaign Name	string	No	PMobo Market - TH
status	The status of the campaign	running	No	running
platform	Allowed OS	Android, iOS, PC Others	No	Android
tracking_link	Tracking link	url	No	https://{cid}. hotrk0.com/offer?offer_id=354634&aff_id=91&aff_sub=[click_id]&aff_pub=[source]& idfa=[idfa]
geo	Allowed countries	refer to appendix	Yes, multiple values separated by comma without space	DE,NO,FI
preview_link	Preview link	url	No	https://play.google.com/ store/apps/details?id=com.zpy.android.mm
price	Payout for channel Default currency is dollar ($)	Floating number with two significant figure	No	1.85
price_model	Pricing mode	cpc,cpi,cpa	No	cpi
app_category	Campaign categories	Refer to appendix	Yes,multiple values separated by comma without space	Game,Subscr iption
start_time	Unix time stamp	1550743682	No	1550743682
start_date	Time of campaign beginning to run	xxxx-xx-xx xx:xx	No	2019-02-21T10:08:02+0000
end_time	Unix time stamp	1582279682	No	1582279682

end_date	Time of campaign being paused; null means long term;	xxxx-xx-xx xx:xx	No	2020-02-21T10:08:02+0000
update_time	The last time when the information associated with this Campaign ID being Modified,unix timestamp	1553499459	No	1553499459
update_date	The last time when the information associated with this Campaign ID being modified.	xxxx-xx-xx xx:xx	No	2019-03-25T07:37:39+0000
effective_time	Time of enabling campaign modification Unix timestamp	1419782400	No	1419782400
effective_date	Time of enabling campaign modification	xxxx-xx-xx xx:xx	No	2019-02-21T10:08:02+0000
exclude_device	Device models NOT allowed to show this campaign.	string	Yes, multiple values separated by comma without space	samsung,son y
exclude_site	Sites NOT allowed to run the campaign	string	Yes, multiple values separated by comma without space	songs.pk
carriers	Target carriers	string	Yes, multiple values separated by comma without space	Digi,Maxis, Celcom
daily_cap	daily max conversion	null or int number	No	12000
icon_link	Usually is the the link where we can get the icon url	string	No	http:// testHugoffers.com /yandexicon96 .png
creative_link	Usually is the list of the data where we can get the image url, and the width and height	json	Yes, multiple values with json format	[{"url":"http:// testHugoffers.com /123456.jpg", "width":1200,"height":627}]

video_link	Usually is the list of the data where we can get the video url, video duration, width and height	json	Yes, multiple values with json format, duration is the video length in second	[{"url":"http:// testHugoffers.com /65432.mp4", "duration":30, "width":800,"height":600}]
app_name	App Name	string	No	Poker Texas Polski
app_desc	App Description	string	No	Poker Texas online
app_size	App size. Default unit is MB	floating number with one significant figure	No	3.7
app_rate	App rate in google play	floating number with one significant figure	No	4.3
app_id	bundle id in appstore or package name in google play	string	No	944846798
min_android_ version	Allowed min Android version if the platform is Android.	refer to appendix	No	1.1
max_android_ version	Allowed max Android version if the platform is Android.	refer to appendix	No	5.0
min_ios_version	Allowed max iOS version if the platform is iOS.	refer to appendix	No	2.0
max_ios_version	Allowed max iOS version if the platform is iOS.	refer to appendix	No	8.0
requirement_traffic	Traffic reqirement. “null” means all kinds of traffic allowed	refer to appendix	Yes, multiple values separated by comma without space	Incent no allowe Adult no Allowed,
performance_criteria	kpi	kpi	Yes	Second day retention rate above 35%

white_source	whitelist,format: “mid_publisher_pubid_subid”	string	Yes, multiple values separated by comma without space	2425_10323,2425_10215
black_source	blacklist,format: “mid_publisher_pubid_subid”	string	Yes, multiple values separated by comma without space	2500_4781,2500_4588

Note1:

You may not receive the following four parameters, “min_android_version”,

“max_android_version”, “min_ios_version” and “max_ios_version”, at the same time. If “platform” is Android, you will only receive “min_android_version” and “max_android_version”. Otherwise, you will only receive “min_ios_version” and “max_ios_version”.

Note2:

“campid” is our campaign’s unique index. Our “tracking_link” may be changed, due to the server migration. So if you use “tracking_link” to match campaign information requested by API to which you’ve received from us before, please refer to the below string, part of “tracking_link”, which does not change during campaign’s life time.

354634 remains the same during campaign’s flight time.

e.g.:

https://{cid}.hotrk0.com/offer?offer_id=354634&aff_id=91&aff_sub=[click_id]&aff_pub=[source]&advertising_id=[advertising_id]&idfa=[idfa]

2.3.3 example

{

total_offers_num: 1,

max_page: 1,

page: 1,

offers_num_this_page: 1,

success: true,

offers: [

{

campid: "354634",

offer_name: "tap4fun_Spartanwars_ru",

status: "running",

platform: "Android",

tracking_link:"https://{cid}.hotrk0.com/offer?offer_id=354634&aff_id=91&aff_sub=[click_id]&aff_pub=[source]&advertising_id=[advertising_id]",

geo: "MY",

preview_link:"https://play.google.com/store/apps/details?id=com.tap4fun.spartanwar", price: 1,

price_model: "cpi",

app_category: "Game",

start_time: "1553498486",

start_date: "2019-03-25T07:21:26+0000",

end_time: "1585034486",

end_date: "2020-03-24T07:21:26+0000",

update_time: "1553502101",

update_date: "2019-03-25T08:21:41+0000",

effective_time: "1553498486",

effective_date: "2019-03-25T07:21:26+0000",

exclude_device: "",

exclude_site: "0",

carriers: "",

daily_cap: 100,

icon_link: "https://lh3.googleusercontent.com/rZkpGk1TcmElfKXLC_NZldKGW8rPPngTuTfmJ 9Z7SfF_Qy6vN1u4Ymy3JzNIQ9e9ZqN3=w300",

creatives_link: [{"url":"http://hugoffers.com/1.jpg","width":1200,"height":627},

{"url":"http://test.hugoffers.com/2.jpg","width":640,"height":100}]

video_link:[ {"url":"http://testhugoffers.com/4.mp4","duration":30,"width":1200,"height":627},{"url":"http://testhugoffers.com/5.jpg","duration":15,"width":640,"height":100}]

app_name: "",

app_desc: "",

app_size: "0",

app_rate: "0",

app_id: "com.tap4fun.spartanwar",

min_android_version: "",

max_android_version: "",

min_ios_version:"5.0",

max_ios_version:"",

requirement_traffic:"non-incent",

performance_criteria:"kpi details",

white_source:"",

black_source:""

}

]

}

3. Appendix

3.1 OS Version

3.1.1 Android Version

min	max
null	null
1.1	1.1
1.5	1.5
1.6	1.6
2.0	2.0
2.1	2.1
2.2	2.2
2.3	2.3
3.0	3.0
3.1	3.1
3.2	3.2
4.0	4.0
4.1	4.1
4.2	4.2
4.3	4.3
4.4	4.4
4.5	4.5
5.0	5.0
6.0	6.0
7.0	7.0

3.1.2 iOS Version

min	max
null	null
2.0	2.0
2.1	2.1

2.2	2.2
3.0	3.0
3.1	3.1
3.2	3.2
4.0	4.0
4.1	4.1
4.2	4.2
4.3	4.3
5.0	5.0
5.1	5.1
6.0	6.0
7.0	7.0
7.0.1	7.0.1
7.0.2	7.0.2
7.0.3	7.0.3
7.0.4	7.0.4
7.0.5	7.0.5
7.0.6	7.0.6
7.1	7.1
7.1.1	7.1.1
7.1.2	7.1.2
8.0	8.0
9.0	9.0
10.0	10.0

3.2 GEO

country	geo
Angola	AO
Afghanistan	AF
Albania	AL
Algeria	DZ

Andorra	AD
Anguilla	AI
Antigua and Barbuda	AG
Argentina	AR
Armenia	AM
Ascension
Australia	AU
Austria	AT
Azerbaijan	AZ
Bahamas	BS
Bahrain	BH
Bangladesh	BD
Barbados	BB
Belarus	BY
Belgium	BE
Belize	BZ
Benin	BJ
BermudaIs.	BM
Bolivia	BO
Botswana	BW
Brazil	BR
Brunei	BN
Bulgaria	BG
Burkina-faso	BF
Burma	MM
Burundi	BI
country	geo
Cameroon	CM
Canada	CA

Cayman Is.
Central African Republic	CF
Chad	TD
Chile	CL
China	CN
Colombia	CO
Congo	CG
Cook Is.	CK
Costa Rica	CR
Cuba	CU
Cyprus	CY
Czech Republic	CZ
Denmark	DK
Djibouti	DJ
Dominica Rep.	DO
Ecuador	EC
Egypt	EG
EISalvador	SV
Estonia	EE
Ethiopia	ET
Fiji	FJ
Finland	FI
France	FR
French Guiana	GF
Gabon	GA
Gambia	GM
Georgia	GE
Germany	DE
Ghana	GH
Gibraltar	GI

Greece	GR
Grenada	GD
Guam	GU
Guatemala	GT
Guinea	GN
Guyana	GY
Haiti	HT
Honduras	HN
Hongkong	HK
Hungary	HU
Iceland	IS
India	IN
Indonesia	ID
Iran	IR
Iraq	IQ
Ireland	IE
Israel	IL
Italy	IT
IvoryCoast
Jamaica	JM
Japan	JP
Jordan	JO
Kampuchea (Cambodia )	KH
Kazakstan	KZ
Kenya	KE
Korea	KR
Kuwait	KW
Kyrgyzstan	KG
Laos	LA
Latvia	LV

Lebanon	LB
Lesotho	LS
Liberia	LR
Libya	LY
Liechtenstein	LI
Lithuania	LT
Luxembourg	LU
Macao	MO
Madagascar	MG
Malawi	MW
Malaysia	MY
Maldives	MV
Mali	ML
Malta	MT
Mauritius	MU
Mexico	MX
Moldova, Republic of	MD
Monaco	MC
Mongolia	MN
Montserrat Is	MS
Morocco	MA
Mozambique	MZ
Namibia	NA
Nauru	NR
Nepal	NP
Netherlands	NL
NewZealand	NZ
Nicaragua	NI
Niger	NE
Nigeria	NG

North Korea	KP
Norway	NO
Oman	OM
Pakistan	PK
Panama	PA
Papua New Cuinea	PG
Paraguay	PY
Peru	PE
Philippines	PH
Poland	PL
French Polynesia	PF
Portugal	PT
PuertoRico	PR
Qatar	QA
Romania	RO
Russia	RU
Saint Lueia	LC
Saint Vincent	VC
San Marino	SM
Sao Tome and Principe	ST
Saudi Arabia	SA
Senegal	SN
Seychelles	SC
Sierra Leone	SL
Singapore	SG
Slovakia	SK
Slovenia	SI
Solomon Is	SB
Somali	SO
South Africa	ZA

Spain	ES
Sri Lanka	LK
St.Lucia	LC
St.Vincent	VC
Sudan	SD
Suriname	SR
Swaziland	SZ
Sweden	SE
Switzerland	CH
Syria	SY
Taiwan	TW
Tajikstan	TJ
Tanzania	TZ
Thailand	TH
Togo	TG
Tonga	TO
Trinidad and Tobago	TT
Tunisia	TN
Turkey	TR
Turkmenistan	TM
Uganda	UG
Ukraine	UA
United Arab Emirates	AE
United Kiongdom	GB
United States of America	US
Uruguay	UY
Uzbekistan	UZ
Venezuela	VE
Vietnam	VN
Yemen	YE

Yugoslavia	YU
South Africa	ZA
Zimbabwe	ZW
Zaire	ZR
Zambia	ZM

3.3 App Category

We use the same categories as Google Play and Appstore. The possible value is as follows.

Business, Game, Subscription, Books and Reference, Comics, Communications, Education, Entertainment, Finance, Health and Fitness, Libraries and Demo, Lifestyle, Live Wallpapers, Media and Video, Medical, Music and Audio, News and Magazines, Personalization, Photography, Productivity, Shopping, Social, Sports, Tools,

Transportation, Travel and Local, Weather, Widgets, Action, Adventure, Arcade, Board, Card, Casino, Casual,Educational, Family, Music, Puzzle, Racing, Role Playing, Simulation, Strategy, Trivia, Word