API Documents
目录
1. Offer List API
offer list api
获取渠道商所有订单信息。
请求地址
GET: http://api.cfmobiinternet.com/v1?token={token}
参数说明
| 参数 | 说明 |
|---|---|
| {token} | 渠道商 token |
请求响应
| 参数 | 返回类型 | 说明 |
|---|---|---|
| total_offers_num | int | 总条数 |
| success | boolean | true:成功,false:失败 |
| offers | List | 订单数据,数据类型为集合,具体见 offerData |
offerData
| 参数 | 返回类型 | 说明 |
|---|---|---|
| campid | int | 订单号 |
| offer_name | string | 订单名称 |
| platform | string | 平台 |
| tracking_link | string | Tracking link |
| geo | string | 国家 |
| preview_link | String | 谷歌商城地址 |
| price | float | 价格 |
| payout_model | string | 价格模式 |
| icon_link | string | 图标地址 |
| daily_cap | string | 每日转化量 |
| app_name | string | app 名称 |
| app_id | string | app 包名 |
| performance_criteria | string | 限制条件,kpi |
示例响应
{
"offers": [
{
"app_size": "",
"platform": "Android",
"campid": 1,
"offer_name": "com.king.candycrushsaga_ID",
"daily_cap": 100,
"geo": "ID",
"app_name": "Candy Crush Saga",
"preview_link": "https://play.google.com/store/apps/details?id=com.king.candycrushsaga",
"price": 0.04,
"app_id": "com.king.candycrushsaga",
"performance_criteria": "kpi details:purchase rate>0.5%",
"tracking_link": "http://track.cfmobiinternet.com/offer?offer_id=1&aff_id=81&advertising_id={advertising_id}&idfa={idfa}&aff_sub={click_id}&aff_pub={source}&ip={ip}",
"payout_model": "CPI"
}
],
"success": true,
"total_offers_num": 2
}
2. Tracking Link
Trackinglink
拉取到的订单中的 tracking_link 地址示例如下,必须替换地址中 {} 中的参数,根据参数说明填写,必填项务必传入。
http://track.cfmobiinternet.com/offer?offer_id=1&aff_id=81&advertising_id={advertising_id}&idfa={idfa}&aff_sub={click_id}&aff_pub={source}&ip={ip}
参数说明
| Tracking Parameters | Type | Required | Description |
|---|---|---|---|
| offer_id | String | Yes | 订单列表接口中 tracking_link 自动填充 |
| aff_id | String | Yes | 订单列表接口中 tracking_link 自动填充 |
| aff_pub | String | Yes | 下游分渠道,最大长度 30 |
| aff_sub | String | Yes | 渠道点击 id,最大长度 300 |
| idfa | String | Yes if ios | Apple's advertiser identifier with iOS 6+. |
| advertising_id | String | Yes if android | Google's advertising identifier, gaid |
| ip | String | Yes | ip 地址,最大长度 30 |
| event_name | String | No | 事件名称,最大长度 200 |
| android_id | String | No | Android Device ID. |
| user_agent | String | Yes | User Agent In Header. |
| site_id | String | No | app id, package name, website url (App/Website) |
| aff_lang | String | No | Device two-character language code. |
| aff_sub2 | String | No | 渠道自定义参数,长度 1000 |
| aff_sub3 | String | No | 渠道自定义参数,长度 1000 |
| aff_sub4 | String | No | 渠道自定义参数,长度 1000 |
| aff_sub5 | String | No | 渠道自定义参数,长度 1000 |
| aff_sub6 | String | No | 渠道自定义参数,长度 1000 |
| aff_sub7 | String | No | 渠道自定义参数,长度 1000 |
| aff_sub8 | String | No | 渠道自定义参数,长度 1000 |
3. 宏参数
宏参数
转化时参数替换如下。
| 参数 | 说明 |
|---|---|
| aff_sub | 渠道点击 ID |
| advertising_id | 安卓谷歌用户 |
| idfa | 苹果系统用户 |
| event_name | 事件名称 |
| event_data | 事件数据 |
| payout | 价格 |
| aff_sub2 | 渠道自定义参数 |
| aff_sub3 | 渠道自定义参数 |
| aff_sub4 | 渠道自定义参数 |
| aff_sub5 | 渠道自定义参数 |
| aff_sub6 | 渠道自定义参数 |
| aff_sub7 | 渠道自定义参数 |
| aff_sub8 | 渠道自定义参数 |