1.Introduction
• This document will introduce SuperADS API. Advanced partners can get campaign information by calling API.
• SuperADS API is built on HTTP proto using GET / POST way to obtain the response content. Notably, to call our API, please contact with your account manager get your API Key for authentication. Since anyone can conduct request on your account’s behalf with the API Key, please keep your API Key confidential.
• Please contact with your account manager to get unique request API Key. Anyone can use your API key, Please keep key safe
2.Use case
URL
| Parameters | Description |
|---|---|
| token | Token is API key. |
| u（小写） | Publisher username. |
| page | Current page NO. |
| page_size | Page size, Max is 500, default is 100. |
XML URL Sample
http://offer.superads.cn/v1/offers?token=[token]&u=[username]&page_size=100&page=1
token is API key.
JSON URL Sample
http://offer.superads.cn/v1/jsons?token=[token]&u=[username]&page_size=100&page=1
token is API key.
URL
| Parameters | Type | Required | Description |
|---|---|---|---|
| token | String | Yes | MD5(key) |
| u | String | Yes | Publisher username |
| page | int | Yes | Page No. |
| page_size | int | Yes | The size per page |
Note: If get all records please do not pass the page or page_size parameters. If pass one the the page and page_size, the max and default page size is 100. The default page No. is one. If the page No. over the total page, it only response the last one of the records. The page nation info will response in the HTTP headers.
Response data.
The response data is the json format. It only contains the publisher offers records.
Response header
| Parameters | Description |
|---|---|
| X-Pagination-Current-Page | The current page No. |
| X-Pagination-Page-Count | Total pages.Total pages. |
| X-Pagination-Per-Page | Page size. |
| X-Pagination-Total-Count | Total count |
Response body
"total_count” : Total Offers Count
"total_page" : Total Pages Count
"page_size" : Total number of Per page
"now_page" : Current Page Number
"offers" : offer list
Offers:
| Parameters | Description | |
|---|---|---|
| id | Campaign ID | |
| campaign_name | ||
| os | Platform | |
| target_geo | Null or Global is no limit | |
| payout | ||
| pricing_mode | ||
| daily_cap | ||
| status | Running or paused | |
| created _time | ||
| end_time | ||
| preview_link | ||
| link | ||
| traffic_source | ||
| icon | ||
| category | ||
| notes | ||
| package_name | ||
| carrier | ||
| conversion_flow | ||
| restriction | ||
| creative | id | |
| campaign_id | ||
| type | 1:banner,2:video | |
| link | ||
| create_time | ||
Example:
{
"offers": [
{
"id": 174
"campaign_name": "test-spiroox",
"os": "All,",
"target_geo": "MX",
"payout": "0.1",
"pricing_mode": "CPA",
"daily_cap": 100,
"status": "Running",
"created_time": "2015-03-22 11:23:00",
"end_time": "",
"preview_link": "/v1/jsons?token=e97d95cf524077995564bfabcb8ad00b4a&u=superads&page_size=1&page=1",
"link": "http://trk.superads.cn/index.php?camp=174&ch_id=1",
"conversion_flow": "",
"carrier": "",
"traffic_source": "Non-Incent, No adult",
"icon": "",
"category": "",
"notes": "",
"package_name": "",
"restriction": "",
"creative": []
}
],
"total_count": 41971,
"total_page": 420,
"now_page": "1",
"page_size": "100"
}