Skip to content

流量主 API

流量主端接口前缀为 /api/publisher。除登录 / 注册 / 找回密码外,均需携带流量主 JWT:Authorization: Bearer <token>

响应结构、分页与错误码约定见 概述与鉴权

认证

登录

POST /api/publisher/auth/login

参数类型必填说明
usernamestring用户名或注册邮箱
passwordstring登录密码
bash
curl -X POST https://api.adbnk.co/api/publisher/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username":"pub_demo","password":"secret123"}'

响应结构同广告主登录,返回 token / token_type / expires_in / user

其他认证接口

方法路径说明
POST/auth/register注册
POST/auth/forgot-password发送重置邮件,参数 email
POST/auth/reset-password参数 tokennew_passwordconfirm_password
POST/auth/logout登出
GET/auth/profile当前登录流量主信息
POST/auth/password修改密码(old_password/new_password/confirm_password

站点(Site)

列表

GET /api/publisher/sites

参数类型必填说明
page / page_sizeint分页
keywordstring名称/域名搜索
statusstring状态
audit_statusstring审核状态
start_date / end_datedate创建时间范围

创建站点

POST /api/publisher/sites

参数类型必填说明
namestring站点名称
media_typestring媒体类型:WEB(默认)/APP/MINI_PROGRAM
domainstring是*WEB 类型必填,需为合法域名且未被占用
app_packagestring是*APP/小程序必填,包名唯一
urlstring站点 URL,WEB 未填时自动用 https://<domain>
descriptionstring站点描述
industry_idint行业 ID
icpstringICP 备案号
bash
curl -X POST https://api.adbnk.co/api/publisher/sites \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"name":"我的博客","media_type":"WEB","domain":"blog.example.com"}'

新建站点默认 audit_status=PENDING,需审核通过后方可创建广告位。

站点其他操作

方法路径说明
GET/sites/{id}详情
PUT/sites/{id}更新
DELETE/sites/{id}删除
POST/sites/{id}/toggle启停
GET/sites/{id}/stats站点统计
GET/sites/{id}/verify-code获取归属验证代码
POST/sites/{id}/verify验证站点归属,参数 method

广告位(Zone)

列表

GET /api/publisher/zones

参数类型必填说明
site_idint按站点筛选
typestring广告类型筛选
statusstring状态
audit_statusstring审核状态
keywordstring名称搜索

创建广告位

POST /api/publisher/zones

参数类型必填说明
namestring广告位名称
site_idint所属站点,须属于当前流量主且已审核通过
ad_type / typestring广告类型,如 BANNER(默认)/NATIVE/VIDEO/POPUP/REWARDED
ad_format_idint广告格式 ID
zone_type_idint广告位类型 ID
size_idint尺寸 ID
widthint宽度,默认 300
heightint高度,默认 250
positionstring位置,默认 CONTENT
devicestring设备,默认 ALL
pricing_typesstring计费类型,默认 CPC,CPM
floor_price_cpcnumberCPC 底价,默认 0
floor_price_cpmnumberCPM 底价,默认 0

创建成功后系统自动生成唯一 zone_key(形如 zone_ab12cd34),用于广告请求。

广告位其他操作

方法路径说明
GET/zones/{id}详情
PUT/zones/{id}更新(site_id 不可改)
DELETE/zones/{id}删除
POST/zones/{id}/toggle启停
GET/zones/{id}/code获取投放代码
GET/zones/{id}/preview预览
POST/zones/{id}/submit-audit提交审核
GET/zones/{id}/stats广告位统计

获取到 zone_key 后即可发起广告请求,详见 广告请求 API

收益报表

方法路径说明
GET/statistics/report汇总报表
GET/statistics/sites按站点维度
GET/statistics/zones按广告位维度
GET/statistics/region地域(geo)报表
GET/statistics/hourly分时报表
GET/statistics/device设备报表
GET/statistics/export导出

GET /api/publisher/statistics/report 参数:

参数类型必填说明
start_datedate起始日期,默认 7 天前
end_datedate结束日期,默认今天
group_bystring分组维度,默认 date
site_idint指定站点

提现

方法路径说明
GET/withdrawals/balance查询可提现余额
GET/withdrawals提现记录列表
POST/withdrawals发起提现
GET/withdrawals/transactions资金流水
GET/withdrawals/payment-methods可用提现渠道
GET/withdrawals/bank-cards银行卡列表
POST/withdrawals/bank-cards新增银行卡
DELETE/withdrawals/bank-cards/{id}删除银行卡
GET/withdrawals/{id}提现详情
POST/withdrawals/{id}/cancel取消提现

发起提现

POST /api/publisher/withdrawals

参数类型必填说明
amountnumber提现金额,须大于 0 且不低于渠道最小额
payment_method / channelstring提现渠道:BANK/USDT/PAYPAL/PAXUM
account_infostring收款账户信息(渠道相关)
bank_infoobject银行渠道的账户明细

KYC 硬门禁

提现要求账户完成 KYC 实名认证(kyc_status = approved)且资料完善度达到 verified,否则返回 412,响应 data 中包含 requires_kyckyc_statuskyc_url 等提示字段。

bash
curl -X POST https://api.adbnk.co/api/publisher/withdrawals \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"amount": 300, "payment_method": "USDT", "account_info": "TRC20:TXxxxx"}'

手续费与税费按平台及渠道配置计算,最终到账金额 = 提现金额 − 手续费 − 税费。结算与提现规则详见 结算与提现指南

TIP

更多流量主功能(黑名单、通知绑定、返佣等)请以流量主控制台为准。

按 MIT 许可发布的文档内容。