PartnerBoost Merchant API
You can call PartnerBoost merchant APIs using curl. All requests require the X-Api-Key header for authentication.
Please contact CSM to get the API key.
Setup
OpenClaw (and compatible clients such as QClaw) decide where configuration lives and how secrets are wired. This Skill does not document a canonical config file, layout, or JSON shape—you only need PARTNERBOOST_API_KEY in the process environment when API calls run. Use your client’s official instructions to supply it.
Authentication
Every request must include:
CODEBLOCK0
Base URL
CODEBLOCK1
API Pattern
All WebUI APIs follow this pattern:
- - GET: INLINECODE2
- POST: INLINECODE3
Response Format
All APIs return JSON: { "code": 0, "message": "ok", "data": ... }. Code 0 means success.
Paged responses include: total_size, total_page, page_size, page_num, current_size in the data.
1. Transaction (订单)
1.1 List Transactions
Query orders with filters. Supports pagination and sorting.
CODEBLOCK2
Parameters (all optional):
- -
page_num (int): page number, default 1 - INLINECODE11 (int): items per page, default 20
- INLINECODE12 (int): start time, Unix timestamp (10-digit)
- INLINECODE13 (int): end time, Unix timestamp (10-digit)
- INLINECODE14 (string): filter by media ID
- INLINECODE15 (string): order status
- INLINECODE16 (string): search keyword
- INLINECODE17 (string): sort field
- INLINECODE18 (string): asc or desc
1.2 Transaction Statistics
Get order statistics summary.
CODEBLOCK3
Parameters (all optional):
- -
start_date, end_date, medium_id, status — same as above
1.3 Recent Transactions
Get the latest 10 orders. No parameters needed.
CODEBLOCK4
2. Performance (业绩)
2.1 Performance Charts
Get performance chart data (clicks, orders, commission trends).
CODEBLOCK5
Parameters:
- -
start_date (int, required): Unix timestamp (10-digit) - INLINECODE24 (int, required): Unix timestamp (10-digit)
- INLINECODE25 (string): day, week, or month. Default: day
- INLINECODE26 (string): filter by media ID
- INLINECODE27 (string): filter by channel
- INLINECODE28 (int): filter by partner group
2.2 Performance List
Get performance detail list with pagination.
CODEBLOCK6
Parameters:
- -
start_date (int, required): Unix timestamp (10-digit) - INLINECODE30 (int, required): Unix timestamp (10-digit)
- INLINECODE31 , INLINECODE32
- INLINECODE33 (string): day, week, month, medium, or channel
- INLINECODE34 ,
channel, partner_group_id — same as charts - INLINECODE37 (string): sort field
- INLINECODE38 (string): asc or desc
2.3 Performance Totals
Get performance summary totals.
CODEBLOCK7
Parameters:
- -
start_date (int, required): Unix timestamp (10-digit) - INLINECODE40 (int, required): Unix timestamp (10-digit)
- INLINECODE41 ,
channel, INLINECODE43
2.4 Search Partner Performance
Search partners by keyword in performance reports.
CODEBLOCK8
Parameters:
- -
word (string, required): search keyword
3. Account / Billing (结算)
3.1 Billing List
Get billing records with filters.
CODEBLOCK9
Parameters (all optional):
- -
page_num, INLINECODE46 - INLINECODE47 (string): media ID
- INLINECODE48 (string): billing IDs, comma-separated
- INLINECODE49 (int): start time, Unix timestamp
- INLINECODE50 (int): end time, Unix timestamp
- INLINECODE51 ,
payment_type, status, INLINECODE54
3.2 Account Info
Get account information including balance.
CODEBLOCK10
3.3 Current Plan
Get current subscription plan details.
CODEBLOCK11
3.4 Prepayment List
Get prepayment records.
CODEBLOCK12
Parameters (all optional): page_num, page_size, mid, time_start, INLINECODE59
PartnerBoost 商户 API
您可以使用 curl 调用 PartnerBoost 商户 API。所有请求都需要在请求头中添加 X-Api-Key 进行身份验证。
请联系客户成功经理获取 API 密钥。
设置
OpenClaw(以及兼容的客户端如 QClaw)决定了配置的存放位置以及密钥的注入方式。本技能不提供规范的配置文件、布局或 JSON 格式——您只需在 API 调用运行时,在进程环境中设置 PARTNERBOOSTAPIKEY 环境变量即可。请按照您客户端的官方说明进行配置。
身份验证
每个请求必须包含:
-H X-Api-Key: $PARTNERBOOSTAPIKEY
基础 URL
https://app.partnerboost.com
API 模式
所有 WebUI API 遵循以下模式:
- - GET: curl -s -H X-Api-Key: $PARTNERBOOSTAPIKEY https://app.partnerboost.com/a/{controller}/{action}?param1=value1¶m2=value2
- POST: curl -s -X POST -H X-Api-Key: $PARTNERBOOSTAPIKEY -H Content-Type: application/json -d {key:value} https://app.partnerboost.com/a/{controller}/{action}
响应格式
所有 API 返回 JSON 格式:{ code: 0, message: ok, data: ... }。code 为 0 表示成功。
分页响应包含以下字段:totalsize、totalpage、pagesize、pagenum、current_size。
1. 订单
1.1 查询订单列表
根据筛选条件查询订单。支持分页和排序。
bash
curl -s -H X-Api-Key: $PARTNERBOOSTAPIKEY \
https://app.partnerboost.com/a/transaction/list3?pagenum=1&pagesize=20&startdate=1735689600&enddate=1741737600
参数(均为可选):
- - pagenum(整数):页码,默认为 1
- pagesize(整数):每页条数,默认为 20
- startdate(整数):开始时间,Unix 时间戳(10 位数字)
- enddate(整数):结束时间,Unix 时间戳(10 位数字)
- mediumid(字符串):按媒体 ID 筛选
- status(字符串):订单状态
- searchword(字符串):搜索关键词
- sorttype(字符串):排序字段
- sortorder(字符串):升序或降序
1.2 订单统计
获取订单统计摘要。
bash
curl -s -H X-Api-Key: $PARTNERBOOSTAPIKEY \
https://app.partnerboost.com/a/transaction/liststats?startdate=2026-01-01&end_date=2026-03-12
参数(均为可选):
- - startdate、enddate、medium_id、status——同上
1.3 最近订单
获取最近 10 条订单。无需参数。
bash
curl -s -H X-Api-Key: $PARTNERBOOSTAPIKEY \
https://app.partnerboost.com/a/transaction/nearly_list
2. 业绩
2.1 业绩图表
获取业绩图表数据(点击量、订单数、佣金趋势)。
bash
curl -s -H X-Api-Key: $PARTNERBOOSTAPIKEY \
https://app.partnerboost.com/a/performance/chartsv2?startdate=1735689600&enddate=1741737600&groupby=day
参数:
- - startdate(整数,必填):Unix 时间戳(10 位数字)
- enddate(整数,必填):Unix 时间戳(10 位数字)
- groupby(字符串):按天、周或月分组。默认:按天
- mediumid(字符串):按媒体 ID 筛选
- channel(字符串):按渠道筛选
- partnergroupid(整数):按合作伙伴分组筛选
2.2 业绩列表
获取带分页的业绩详情列表。
bash
curl -s -H X-Api-Key: $PARTNERBOOSTAPIKEY \
https://app.partnerboost.com/a/performance/listv2?startdate=1735689600&enddate=1741737600&pagenum=1&page_size=20
参数:
- - startdate(整数,必填):Unix 时间戳(10 位数字)
- enddate(整数,必填):Unix 时间戳(10 位数字)
- pagenum、pagesize
- groupby(字符串):按天、周、月、媒体或渠道分组
- mediumid、channel、partnergroupid——与图表相同
- sorttype(字符串):排序字段
- sortorder(字符串):升序或降序
2.3 业绩总计
获取业绩汇总总计。
bash
curl -s -H X-Api-Key: $PARTNERBOOSTAPIKEY \
https://app.partnerboost.com/a/performance/chartstotal?startdate=1735689600&end_date=1741737600
参数:
- - startdate(整数,必填):Unix 时间戳(10 位数字)
- enddate(整数,必填):Unix 时间戳(10 位数字)
- mediumid、channel、partnergroup_id
2.4 搜索合作伙伴业绩
在业绩报告中按关键词搜索合作伙伴。
bash
curl -s -H X-Api-Key: $PARTNERBOOSTAPIKEY \
https://app.partnerboost.com/a/performance/search_partner?word=keyword
参数:
3. 结算
3.1 结算列表
获取带筛选条件的结算记录。
bash
curl -s -H X-Api-Key: $PARTNERBOOSTAPIKEY \
https://app.partnerboost.com/a/account/billinglist?pagenum=1&page_size=20
参数(均为可选):
- - pagenum、pagesize
- mid(字符串):媒体 ID
- ids(字符串):结算 ID,以逗号分隔
- timestart(整数):开始时间,Unix 时间戳
- timeend(整数):结束时间,Unix 时间戳
- paymentmethod、paymenttype、status、search_word
3.2 账户信息
获取账户信息,包括余额。
bash
curl -s -H X-Api-Key: $PARTNERBOOSTAPIKEY \
https://app.partnerboost.com/a/account/account_info
3.3 当前套餐
获取当前订阅套餐详情。
bash
curl -s -H X-Api-Key: $PARTNERBOOSTAPIKEY \
https://app.partnerboost.com/a/account/current_plan
3.4 预付款列表
获取预付款记录。
bash
curl -s -H X-Api-Key: $PARTNERBOOSTAPIKEY \
https://app.partnerboost.com/a/account/prepayment?pagenum=1&page_size=20
参数(均为可选):pagenum、pagesize、mid、timestart、timeend