简介

Offer API 为开发者提供通过 S2S 方式获取广告 Offer 信息的接口。

开发者在使用时需注意以下几点：

• 请求方式：GET
• 响应格式：JSON
• 访问地址：服务端访问，不支持客户端直接请求
• 建议：每 10-15 分钟请求一次，避免频繁请求

请求方式

请求地址

https://offer-api.bonamobi.com/v1/offer-api/offers?app_id={APP_ID}&app_key={APP_KEY}&page_size={NUM}&page_no={NUM}

请求方法

GET

请求参数

参数	描述	是否必传
app_id	渠道 ID，从 AM 处获取	是
app_key	渠道 Key，从 AM 处获取	是
page_size	单页数量，默认为 500，数值应小于等于 500	否
page_no	页码，默认为 1	否

示例请求

https://offer-api.bonamobi.com/v1/offer-api/offers?app_id=10000&app_key=xxxxx-xxxx-xxxxx&page_size=2&page_no=1

接口响应

响应参数

参数名称	参数类型	具体描述
code	int	结果：0-success，非 0 表示请求失败（如：10001-参数错误）
msg	string	响应："OK"表示拉取成功，code 非"OK"时表示请求失败的原因
data	json object	数据详情，格式为 json

data object （返回数据详情）

参数名称	参数类型	具体描述
total_count	int	拉取到的 offer 总数
page_no	int	当前页码
offers	object[ ]	offer 详情，格式为数组

Offer Object（Offer 详情）

参数名称	参数类型	具体描述
status	int	状态码，1-success
id	string	offer id
name	string	offer 名称
app_name	string	offer 对应的应用名
pkg_name	string	offer 对应的包名
description	string	offer 描述
icon	string	offer 对应的 icon
payout_model	string	offer 结算类型：CPI / CPA / CPE...
payout	string	offer 单价，例：0.90
currency	string	offer 货币类型，例：USD
daily_cap	string	offer 日限量，“”字段为空则表示不限
kpi	string	offer 对应的 KPI 信息
expiration_date	string	offer 下线时间，UTC 时间
preview_link	string	offer 对应的跳转地址
tracking_link	string	offer 对应的归因链接
geo	string[ ]	offer 对应的投放国家，[Global]表示全球，[PH] 表示定向菲律宾
geo_exclude	string[ ]	offer 对应的排除国家，“”字段为空表示不做国家限制， [PH]表示排除菲律宾
os	string	offer 对应的应用的操作系统，例：“android” / “ios”
os_vers	string	操作系统版本定向，“”字段为空表示不限制

响应示例

{
  "code": 0,
  "data": {
    "offers": [
      {
        "id": 1392411,
        "name": "com.igg.android.lordsmobile_US",
        "pkg_name": "com.igg.android.lordsmobile",
        "app_name": "王国纪元",
        "payout_model": "CPI",
        "payout": "2.67",
        "currency": "USD",
        "kpi": "cvr 0.2%",
        "tracking_link": "``http://api.bonamobi.com/moonlight/v4?value=5146ea64xxx&click_id={click_id}``"
      }
    ],
    "total_count": 1
  },
  "msg": "OK"
}