Skill: partnerboost-tech-team/partnerboost-brand (version 1.1.1)

--- name: partnerboost-api description: Call PartnerBoost merchant APIs to manage transactions, performance, billing, partners and more version: 1.1.1 tags: [partnerboost, api, merchant] requires: env: - PARTNERBOOST_API_KEY --- # 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: ``` -H "X-[REDACTED_SECRET]" ``` ## Base URL ``` https://app.partnerboost.com ``` ## API Pattern All WebUI APIs follow this pattern: - **GET**: `curl -s -H "X-[REDACTED_SECRET]" "https://app.partnerboost.com/a/{controller}/{action}?param1=value1&param2=value2"` - **POST**: `curl -s -X POST -H "X-[REDACTED_SECRET]" -H "Content-Type: application/json" -d '{"key":"value"}' "https://app.partnerboost.com/a/{controller}/{action}"` ## 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 (`list4`) Query orders with filters and pagination. **`list3` is deprecated**; use **`list4`** (backend: `get_list4`). Simple range query (GET): ```bash curl -s -H "X-[REDACTED_SECRET]" \ "https://app.partnerboost.com/a/transaction/list4?page_num=1&page_size=20&trans_time_start=1735689600&trans_time_end=1741737600" ``` Filters use **`processTransListParams`** on the server. Common fields (all optional unless noted): - `page_num` (int): page number, default 1 - `page_size` (int): page size, default 20 (clamped by server) - `trans_time_start`, `trans_time_end` (int): Unix timestamp (seconds), transaction time range - `trans_keywords` (string): keyword search (order id, tags, SKU, promo, etc., depending on merchant settings) - `trans_tag` (string): tag substring match - `trans_status` (array): e.g. `new`, `void`, `paid`, `effective`, `mixed` (SKU-level rollups) - `trans_sku_status` (array): SKU-level `paid`, `new`, `void`, `effective` - `trans_type` (array): transaction types - `trans_client_device` (array): e.g. `mobile`, `pc`, `admin`, `-` - `trans_norm_id` (array): norm IDs - `partner_channel_id` (array): **channel / medium** filter — numeric site IDs or `PB…` medium codes (server may normalize IDs) - `partner_id` (array): partner user IDs - `partner_group` (array): partner group IDs - `partner_channel_type` (array): `WEBSITE`, `SOCIAL_NETWORK`, `MOBILE` - `partner_location` (array): country codes - `partner_type` (array): `influencer`, `publisher` - `payment_id`, `acc_upload_id`, `performance_bonus_type_id` (int): other filters - Plus Amazon / affiliate-related filters: `amazon_shop_country`, `amazon_product_brand`, `affiliate_type` as implemented server-side Array parameters are easiest via **POST + JSON** (see **API Pattern**). Example: ```bash curl -s -X POST -H "X-[REDACTED_SECRET]" -H "Content-Type: application/json" \ -d '{"page_num":1,"page_size":20,"trans_time_start":1735689600,"trans_time_end":1741737600,"trans_status":["paid"],"partner_channel_id":["PB00001234"]}' \ "https://app.partnerboost.com/a/transaction/list4" ``` Default sort is by transaction time / id descending (server-defined). ### 1.2 Transaction Statistics Get order statistics summary. Uses the **same filter set as 1.1** (`processTransListParams`). ```bash curl -s -H "X-[REDACTED_SECRET]" \ "https://app.partnerboost.com/a/transaction/list_stats?trans_time_start=1735689600&trans_time_end=1741737600" ``` Parameters: same filters as **1.1** (optional). `page_num` / `page_size` are initialized on the server but do not change the aggregated stats shape. ### 1.3 Recent Transactions Get the latest 10 orders. No parameters needed. ```bash curl -s -H "X-[REDACTED_SECRET]" \ "https://app.partnerboost.com/a/transaction/nearly_list" ``` --- ## 2. Performance (业绩) ### 2.1 Performance Charts Get performance chart data (clicks, orders, commission trends). ```bash curl -s -H "X-[REDACTED_SECRET]" \ "https://app.partnerboost.com/a/performance/charts_v2?start_date=1735689600&end_date=1741737600&group_by=day" ``` Parameters: - `start_date` (int, required): Unix timestamp (10-digit) - `end_date` (int, required): Unix timestamp (10-digit) - `group_by` (string): day, week, or month. Default: day - `medium_id` (string): filter by media ID - `channel` (string): filter by channel - `partner_group_id` (int): filter by partner group ### 2.2 Performance List Get performance detail list with pagination. ```bash curl -s -H "X-[REDACTED_SECRET]" \ "https://app.partnerboost.com/a/performance/list_v2?start_date=1735689600&end_date=1741737600&page_num=1&page_size=20" ``` Parameters: - `start_date` (int, required): Unix timestamp (10-digit) - `end_date` (int, required): Unix timestamp (10-digit) - `page_num`, `page_size` - `group_by` (string): day, week, month, medium, or channel - `medium_id`, `channel`, `partner_group_id` — same as charts - `sort_type` (string): sort field - `sort_order` (string): asc or desc ### 2.3 Performance Totals Get performance summary totals. ```bash curl -s -H "X-[REDACTED_SECRET]" \ "https://app.partnerboost.com/a/performance/charts_total?start_date=1735689600&end_date=1741737600" ``` Parameters: - `start_date` (int, required): Unix timestamp (10-digit) - `end_date` (int, required): Unix timestamp (10-digit) - `medium_id`, `channel`, `partner_group_id` ### 2.4 Search Partner Performance Search partners by keyword in performance reports. ```bash curl -s -H "X-[REDACTED_SECRET]" \ "https://app.partnerboost.com/a/performance/search_partner?word=keyword" ``` Parameters: - `word` (string, required): search keyword --- ## 3. Account / Billing (结算) ### 3.1 Billing List Get billing records with filters. ```bash curl -s -H "X-[REDACTED_SECRET]" \ "https://app.partnerboost.com/a/account/billing_list?page_num=1&page_size=20" ``` Parameters (all optional): - `page_num`, `page_size` - `mid` (string): media ID - `ids` (string): billing IDs, comma-separated - `time_start` (int): start time, Unix timestamp - `time_end` (int): end time, Unix timestamp - `payment_method`, `payment_type`, `status`, `search_word` ### 3.2 Account Info Get account information including balance. ```bash curl -s -H "X-[REDACTED_SECRET]" \ "https://app.partnerboost.com/a/account/account_info" ``` ### 3.3 Current Plan Get current subscription plan details. ```bash curl -s -H "X-[REDACTED_SECRET]" \ "https://app.partnerboost.com/a/account/current_plan" ``` ### 3.4 Prepayment List Get prepayment records. ```bash curl -s -H "X-[REDACTED_SECRET]" \ "https://app.partnerboost.com/a/account/pre_payment?page_num=1&page_size=20" ``` Parameters (all optional): `page_num`, `page_size`, `mid`, `time_start`, `time_end`

path: README.md
content: **English** · [简体中文](README.zh-CN.md)

# PartnerBoost Merchant API Skill

This repository provides an **AI Agent Skill** for the PartnerBoost **merchant** side. Agents use natural language to drive `curl` calls against the same WebUI-backed APIs, for orders, performance analytics, billing, account data, and more.

Full Skill instructions and API reference: [`SKILL.md`](./SKILL.md).

## When to use it

- Automate merchant-side queries and summaries in Agent runtimes that support this Skill (e.g. OpenClaw, QClaw, Wukong when configured)
- Single source of truth for auth (`X-Api-Key`) and base URL

## Skill metadata

| Field | Value |
|-------|--------|
| Name | `partnerboost-api` |
| Version | 1.1.1 |
| Tags | partnerboost, api, merchant |

## Prerequisites

1. **API key** — request a merchant API key from your CSM.
2. **Environment** — the Agent must have access to `PARTNERBOOST_API_KEY` (see below).

## Installation

### Skills CLI (`npx skills add`)

Use the [Skills CLI](https://skills.sh/docs/cli) (no global install needed):

```bash
npx skills add <owner>/<repo>
```

Anyone can install from **this repository’s address** on your Git host (GitHub `owner/repo`, a full repo URL, or another format the [Skills CLI](https://skills.sh/docs/cli) accepts). Use the `owner/repo` shown on the repo home page, for example:

```bash
npx skills add OWNER/partnerboost-brand
```

Run `npx skills add --help` for flags such as `-g` / `--global` and `-a` / `--agent` (target Cursor, Claude Code, OpenCode, etc.).

You still need **`PARTNERBOOST_API_KEY`** wherever your agent loads secrets (see **OpenClaw / QClaw** below, or your editor’s env / secrets UI).

### API key for OpenClaw-compatible clients

**OpenClaw** and **QClaw** own config location and how env vars are passed. This Skill does not prescribe a file path or JSON schema—only that **`PARTNERBOOST_API_KEY`** is available when runs execute. Follow each client’s docs.

### OpenClaw

Register this repo’s [`SKILL.md`](./SKILL.md) as **`partnerboost-api`** using the flow described in [OpenClaw Skills config](https://docs.openclaw.ai/tools/skills-config).

### QClaw

**QClaw** is Tencent’s packaged OpenClaw client (WeChat remote control, ClawHub, optional reuse of an existing OpenClaw setup).

1. Install from [QClaw](https://qclaw.qq.com) and finish onboarding (channels, model, etc.).
2. **Skills:** open **Skills** in the sidebar — install from ClawHub, or add this project as a **custom / GitHub-style** skill if your build supports it.
3. Add this Skill through the client’s UI or the custom-skill flow described in QClaw / OpenClaw documentation.
4. Provide **`PARTNERBOOST_API_KEY`** exactly as your client documents (not duplicated here).

Unofficial walkthrough (Chinese): [qclaw.run](https://www.qclaw.run/zh/) — e.g. [install guide](https://www.qclaw.run/zh/qclaw-anzhuang-jiaocheng/) (includes a **Skills** step).

### Wukong (悟空)

**Wukong** is Alibaba’s enterprise Agent platform (DingTalk AI / standalone app). It ships with an AI capability marketplace and is described as compatible with open Skill-style content.

1. In **Wukong** or **DingTalk** (per your org’s rollout), open the skill / capability entry your admin uses (marketplace, custom skill upload, or developer workflow).
2. Import or register this repository’s [`SKILL.md`](./SKILL.md) under the name **`partnerboost-api`** (or the identifier your platform requires).
3. Configure **`PARTNERBOOST_API_KEY`** in the platform’s environment, secrets, or skill settings (wording varies by version).

Availability (invite / beta) and exact menus change with product updates — follow **DingTalk AI** and **Wukong** official documentation.

## API overview

- **Base URL:** `https://app.partnerboost.com`
- **Auth:** every request needs `X-[REDACTED_SECRET]`
- **Conventions:** GET/POST URL shape, JSON shape (`code` / `message` / `data`), and pagination fields are documented in [`SKILL.md`](./SKILL.md)

Documented areas:

| Area | What it covers |
|------|----------------|
| Transaction | Order list, stats, recent orders |
| Performance | Charts, paged list, totals, partner search |
| Account / Billing | Billing list, account info, current plan, prepayment records |

## Repository layout

```
.
├── README.md        # This file (English)
├── README.zh-CN.md  # 简体中文
└── SKILL.md         # Skill definition and full API reference
```

## Compliance

Usage limits, rate limits, and compliance follow PartnerBoost’s official terms and your contract. Do not expose API keys in logs or chat transcripts.


path: README.zh-CN.md
content: [English](README.md) · **简体中文**

# PartnerBoost 商家端 API Skill

本仓库提供面向 **PartnerBoost 商家端（Merchant）** 的 AI Agent Skill：通过自然语言驱动，让 Agent 使用 `curl` 调用 PartnerBoost WebUI 同源 API，完成订单查询、业绩分析、结算与账户等操作。

核心说明与完整接口文档见仓库根目录的 [`SKILL.md`](./SKILL.md)。

## 适用场景

- 在支持本 Skill 的 Agent 环境中（如 OpenClaw、QClaw、已配置的悟空等），为商家侧自动化查询与汇总数据
- 需要统一认证方式（`X-Api-Key`）与 Base URL 时，作为单一事实来源

## Skill 元信息

| 项 | 值 |
|----|-----|
| 名称 | `partnerboost-api` |
| 版本 | 1.1.1 |
| 标签 | partnerboost, api, merchant |

## 前置条件

1. **API Key**：向 CSM 申请商家端 API Key。
2. **环境变量**：Agent 运行环境需能读取 `PARTNERBOOST_API_KEY`（见下节配置示例）。

## 安装方式

### Skills CLI（`npx skills add`）

使用 [Skills CLI](https://skills.sh/docs/cli)（无需全局安装）：

```bash
npx skills add <owner>/<repo>
```

他人直接用这个 Skill **所在仓库**在代码托管平台上的地址即可安装（GitHub 的 `owner/repo`、完整仓库 URL 等，以 [Skills CLI](https://skills.sh/docs/cli) 支持的格式为准）。把 `<owner>/<repo>` 换成仓库主页上显示的「所有者/仓库名」，例如：

```bash
npx skills add OWNER/partnerboost-brand
```

更多参数见 `npx skills add --help`（如 `-g` / `--global`、`-a` / `--agent` 指定 Cursor、Claude Code、OpenCode 等目标）。

安装完成后仍需配置 **`PARTNERBOOST_API_KEY`**（见下文 OpenClaw / QClaw，或你所用工具的密钥 / 环境变量界面）。

### OpenClaw / QClaw 共用：配置 API Key

**OpenClaw** 与 **QClaw**（腾讯基于 OpenClaw 的桌面客户端）的配置位置、格式以及如何把环境变量注入到运行中的 Agent，**均由各客户端官方文档为准**。本 Skill **不写死**任何配置文件路径或 JSON 结构；唯一要求是执行 API 调用时环境中能读到 **`PARTNERBOOST_API_KEY`**。

### OpenClaw

将本仓库中的 [`SKILL.md`](./SKILL.md) 注册为 **`partnerboost-api`**，具体步骤见 [OpenClaw Skills 配置](https://docs.openclaw.ai/zh-CN/tools/skills-config)。

### QClaw

**QClaw** 为腾讯出品的 OpenClaw 一键客户端（微信远程、ClawHub、可关联已有 OpenClaw 环境等）。

1. 从 [QClaw 官网](https://qclaw.qq.com) 安装并完成引导（渠道、模型等）。
2. **Skills**：在客户端左侧打开 **「Skills」**——可从 **ClawHub** 安装；若支持 **GitHub / 自定义技能**，按客户端说明添加本仓库或其中的 `SKILL.md`。
3. 按 QClaw / OpenClaw 文档，通过界面或自定义技能流程添加本 Skill。
4. **`PARTNERBOOST_API_KEY`**：严格按客户端文档配置（本文不重复具体写法）。

非官方中文教程与安装步骤（含「安装第一个 Skill」）：[qclaw.run](https://www.qclaw.run/zh/) · [QClaw 安装教程](https://www.qclaw.run/zh/qclaw-anzhuang-jiaocheng/)。

### 悟空（钉钉 / 阿里企业级 Agent）

**悟空**为阿里巴巴发布的企业级 AI Agent 平台（独立应用与钉钉内置能力），配套 **AI 能力市场**，并强调兼容开源 Skill 体系。

1. 在 **悟空客户端** 或 **钉钉** 侧（以你所在组织开通方式为准）进入技能 / 能力市场或组织管理员配置的 **自定义 Skill** 入口。
2. 将本仓库的 [`SKILL.md`](./SKILL.md) 按平台要求导入或上架，Skill 标识建议使用 **`partnerboost-api`**（若平台强制其他命名，以平台为准）。
3. 在平台提供的 **环境变量、密钥或 Skill 专属配置** 中填写 **`PARTNERBOOST_API_KEY`**（各版本菜单名称可能不同）。

邀测/公测范围与界面以 **钉钉 AI**、**悟空** 官方文档与公告为准。

## API 概览

- **Base URL**：`https://app.partnerboost.com`
- **认证**：所有请求需带头 `X-[REDACTED_SECRET]`
- **约定**：GET/POST 路径形态、JSON 响应结构（`code` / `message` / `data`）及分页字段说明均写在 [`SKILL.md`](./SKILL.md)

当前文档覆盖的主要模块：

| 模块 | 说明 |
|------|------|
| Transaction | 订单列表、统计、最近订单 |
| Performance | 图表、明细列表、汇总、合作方搜索 |
| Account / Billing | 账单列表、账户信息、当前套餐、预付款记录 |

## 仓库结构

```
.
├── README.md        # English
├── README.zh-CN.md  # 本说明（简体中文）
└── SKILL.md         # Agent Skill 定义与完整 API 参考
```

## 许可与责任

API 的使用范围、速率与合规要求以 PartnerBoost 官方及合同约定为准；请勿在日志或对话中泄露 API Key。


Security scan verdicts — ClawScan: clean | static analysis: clean | VirusTotal: clean | SkillSpector: clean (LOW)