我们检测到您的浏览器可能安装了 第三方淘客插件 ,该插件存在 监听和篡改好单库页面的行为,影响好单库的正常使用且有 隐私数据泄露 的风险。推荐使用官方插件:多兔淘客插件
好单库开放平台 AI 接口文档包

AI Agent / MCP 专用文档入口

使用 AI 快速接入开放平台接口

下载文档包导入 AI 工具,AI 即可按意图路由到正确接口,给出可靠的接入建议。包含接口分类、鉴权规则、权限说明和错误处理。

6 类 AI 可路由接口分类
20+ 可识别业务场景
JSON 响应和错误处理规则

AI 文档使用规则

文档包是接口选择依据,不是自由发挥的素材库。AI 应先判断意图,再从文档中提取明确存在的路径、参数和字段。

先做意图识别

将用户需求归类为商品搜索、商品详情、商品转链、活动推广、订单查询、口令解析、本地生活或错误排查。

再查对应文档

不确定分类时先查接口目录;涉及密钥、签名、权限、平台差异时先查平台接入规则与接口选择。

禁止自行补全

文档未写明的接口路径、请求参数、返回字段、状态码和调用示例,AI 不应编造,应提示以正式接口文档为准。

区分鉴权方式

普通接口使用 apikey 鉴权;增值类接口使用 appkey + appsecret 签名。京东、拼多多、抖音、订单和本地生活接口需确认权限。

失败时查排错文档

遇到鉴权失败、权限不足、参数错误或状态码异常,优先查看错误码与状态码.md,给出可执行的排查建议。

先讲分类再给建议

用户只描述需求时,先指出应查看哪类接口文档,说明所需密钥和必填参数来源,再给具体调用建议。

AI 读取流程

建议将下面流程写入 Agent 系统提示词或知识库检索策略,让 AI 每次回答前都先走文档路由。

下载并导入知识库

下载文档包并解压,将 .md 文件上传到 AI 知识库或粘贴到对话中,保留文件名和目录结构,尤其是 interfaces 目录,方便 AI 通过分类精确检索。

按固定顺序读取

优先读取 AI使用说明.md,再读取接口目录.md;涉及鉴权、签名、权限时读取平台接入规则与接口选择.md;需要具体接口时读取对应分类文档。

输出前做约束检查

回答中应说明接口分类、所需密钥、可能权限、必填参数来源和后续接口;无法在文档中确认的信息必须标注不确定。

失败时进入排错文档

遇到鉴权失败、权限失败、参数错误、请求方式错误或状态码异常时,优先查看错误码与状态码.md,并给出可执行排查建议。

推荐 AI 提示词

可放入 Agent 的系统提示词、知识库说明或工具调用前置规则中。

你是好单库开放平台接口文档助手。
回答任何接口问题前,先根据用户意图选择文档分类:
1. 先查 AI使用说明.md 和 接口目录.md。
2. 涉及密钥、签名、权限、平台差异时,查 平台接入规则与接口选择.md。
3. 需要接口路径、请求参数、返回字段时,只查 interfaces 目录下对应分类文档。
4. 文档未明确的信息不得编造,应说明“当前文档未提供,以正式接口文档为准”。
5. 输出时优先给出接口分类、鉴权方式、权限要求、关键参数、后续接口和错误排查入口。

使用示例

以下示例展示如何在不同 AI 工具中加载文档包并调用接口。

Claude Code / Cursor(终端下载)

在项目终端中运行以下命令,下载并解压文档包后,告知 AI 读取说明文件。

# 1. 下载解压文档包
curl -L https://file.bc.haodanku.com/file/haodanku-openapi-docs.zip \
  -o haodanku-openapi-docs.zip
unzip haodanku-openapi-docs.zip

# 2. 在 CLAUDE.md / .cursorrules 中添加指引:
# "接口开发时先读取 haodanku-openapi-docs/AI使用说明.md"

# 3. 在 AI 对话中输入:
# "读取好单库文档,帮我搜索淘宝商品关键词:连衣裙"
# "查看转链接口需要哪些参数?"

Dify / Coze(知识库上传)

下载解压后,将 .md 文件上传到知识库,再在 Agent 系统提示词中加入路由规则。

# 1. 下载解压文档包,将 .md 文件上传到知识库

# 2. 系统提示词示例(粘贴到 Agent 配置中):
你是好单库接口助手,知识库中已包含接口文档。
回答接口问题前,先判断用户意图,再检索
对应分类文档,禁止编造文档中未写明的内容。

# 3. 用户提问示例:
# "我想查京东商品详情,需要哪些参数?"
# "帮我生成淘宝商品推广链接"
# → AI 检索 interfaces/ 下对应文档并回答

MCP 协议接入(Claude Code / Cursor / Cline)

将文档包配置为 MCP 文件系统服务,AI 按需读取分类文档,无需一次性加载。

# 1. 下载解压文档包到固定路径(同上)

# 2. 在 MCP 配置文件中添加服务:
#    Claude Code → .claude/settings.json
#    Cursor → .cursor/mcp.json
{
  "mcpServers": {
    "haodanku-docs": {
      "command": "npx",
      "args": ["-y", "@modelcontextprotocol/server-filesystem",
               "./haodanku-openapi-docs"]
    }
  }
}

# 3. AI 启动后可按需调用:
# "查看好单库商品接口有哪些"
# "帮我读取转链接口的签名规则"

Claude Code for VS Code

在 VS Code 中使用 Claude Code 扩展,将文档包放入项目后通过对话调用。

# 1. 在 VS Code 终端下载文档包到项目根目录
curl -L https://file.bc.haodanku.com/file/haodanku-openapi-docs.zip \
  -o haodanku-openapi-docs.zip
unzip haodanku-openapi-docs.zip

# 2. 在项目根目录的 CLAUDE.md 中添加指引:
# "接口开发时请先读取 haodanku-openapi-docs/AI使用说明.md"

# 3. 在 Claude Code 面板中直接对话:
# "读取好单库文档,帮我写一个商品搜索的接口封装"
# "查看转链接口需要哪些权限和参数"
# "帮我排查调用商品详情接口返回 1002 错误码"

OpenAI Codex(CLI Agent)

在 Codex 终端 Agent 中加载文档包,利用其文件读取能力按需查阅接口。

# 1. 下载解压文档包
curl -L https://file.bc.haodanku.com/file/haodanku-openapi-docs.zip \
  -o haodanku-openapi-docs.zip
unzip haodanku-openapi-docs.zip

# 2. 在 AGENTS.md 中写入使用规则:
# "开发好单库相关功能时,先读取
#  haodanku-openapi-docs/AI使用说明.md 和接口目录.md,
#  按意图路由到对应分类文档再编码。"

# 3. 启动 Codex 后直接提问:
# "帮我接入好单库订单查询接口,用 Node.js 实现"
# "查一下本地生活接口需要什么特殊权限"

Windsurf

在 Windsurf IDE 中通过 Rules 文件让 AI 自动加载文档上下文。

# 1. 下载文档包到项目根目录
curl -L https://file.bc.haodanku.com/file/haodanku-openapi-docs.zip \
  -o haodanku-openapi-docs.zip
unzip haodanku-openapi-docs.zip

# 2. 创建 .windsurfrules 文件:
# "开发好单库接口时,先读取
#  haodanku-openapi-docs/AI使用说明.md,
#  再按意图查对应分类文档,禁止编造。"

# 3. 在 Cascade 面板中提问:
# "帮我用 PHP 封装好单库商品搜索接口"
# "转链接口需要哪些权限?怎么申请?"

GitHub Copilot Chat

在 VS Code 中用 Copilot Chat 通过 #file 引用文档,获取精准的接口建议。

# 1. 下载文档包到项目中
curl -L https://file.bc.haodanku.com/file/haodanku-openapi-docs.zip \
  -o haodanku-openapi-docs.zip
unzip haodanku-openapi-docs.zip

# 2. 在 Copilot Chat 中通过 #file 引用:
# "#file:haodanku-openapi-docs/AI使用说明.md
#  帮我查询商品搜索接口需要哪些参数"

# 3. 也可添加到 .github/copilot-instructions.md:
# "涉及好单库接口开发时,参考
#  haodanku-openapi-docs 目录中的文档。"

ChatGPT(对话上传)

将文档包上传到 ChatGPT 对话或 GPTs 知识库,直接提问即可获取接口指引。

# 方式一:直接上传到对话
# 1. 下载解压文档包
# 2. 将 .md 文件拖入 ChatGPT 对话窗口
# 3. 提问:"根据文档,帮我接入商品搜索接口"

# 方式二:创建自定义 GPTs
# 1. 在 GPTs 编辑页上传所有 .md 文件到知识库
# 2. 系统提示词中加入:
#    "你是好单库接口助手,回答前先检索知识库
#     中的分类文档,禁止编造未记录的接口。"
# 3. 发布后团队成员可直接使用

Qoder(原通义灵码)

阿里通义灵码支持项目级知识库,将文档导入后 AI 编码时自动参考。

# 1. 下载文档包到项目中
curl -L https://file.bc.haodanku.com/file/haodanku-openapi-docs.zip \
  -o haodanku-openapi-docs.zip
unzip haodanku-openapi-docs.zip

# 2. 在 IDE 中打开通义灵码面板
#    设置 → 项目知识库 → 添加目录:
#    haodanku-openapi-docs/

# 3. 对话中提问:
# "根据好单库文档,帮我实现订单拉取功能"
# "商品转链接口的签名规则是什么?"
# "调用活动接口报错 2001,怎么排查?"

Trae(字节 AI IDE)

在 Trae 中通过项目规则配置让 AI 自动加载好单库接口文档。

# 1. 下载文档包到项目根目录
curl -L https://file.bc.haodanku.com/file/haodanku-openapi-docs.zip \
  -o haodanku-openapi-docs.zip
unzip haodanku-openapi-docs.zip

# 2. 创建 .trae/rules 项目规则:
# "开发好单库相关功能时,先读取
#  haodanku-openapi-docs/AI使用说明.md,
#  按用户意图查接口目录再进入分类文档。"

# 3. 在 Builder 面板中提问:
# "帮我封装好单库口令解析接口"
# "本地生活接口和普通接口鉴权有什么区别?"

OpenClaw(终端 Agent)

OpenClaw 支持项目上下文文件,将文档包配置后 Agent 可自动引用。

# 1. 下载文档包到项目中
curl -L https://file.bc.haodanku.com/file/haodanku-openapi-docs.zip \
  -o haodanku-openapi-docs.zip
unzip haodanku-openapi-docs.zip

# 2. 在项目根目录创建 .openclaw 配置:
# context:
#   - haodanku-openapi-docs/AI使用说明.md
#   - haodanku-openapi-docs/接口目录.md

# 3. 启动 OpenClaw 后提问:
# "帮我用 Go 实现好单库商品搜索接口调用"
# "转链接口的签名怎么生成?"
# "订单接口报权限错误怎么排查?"

Gemini CLI

Google Gemini CLI 支持读取本地文件,下载文档包后可直接引用查询。

# 1. 下载文档包到项目中
curl -L https://file.bc.haodanku.com/file/haodanku-openapi-docs.zip \
  -o haodanku-openapi-docs.zip
unzip haodanku-openapi-docs.zip

# 2. 在 GEMINI.md 中添加项目指引:
# "开发好单库相关接口时,先读取
#  haodanku-openapi-docs/AI使用说明.md,
#  按意图路由到分类文档,禁止编造。"

# 3. 在 Gemini CLI 中提问:
# "读取好单库文档,帮我接入活动推广接口"
# "本地生活接口需要哪些额外权限?"
# "调用转链接口返回签名错误怎么解决?"

意图路由表

AI 应优先使用用户意图映射到文档分类,再从分类文档中提取接口细节。

用户意图 AI 应查看 输出时提醒
商品搜索、商品详情、商品列表 interfaces/商品接口.md 说明平台范围、apikey、分页或商品 ID 等关键参数来源
商品转链、推广链接生成 interfaces/转链接口.md 提醒平台权限、推广位、链接或商品 ID 要求
会场、频道、专题、活动推广 interfaces/活动接口.md 说明活动平台、转链方式和后续订单查询入口
订单查询、订单拉取、佣金同步 interfaces/订单接口.md 提醒订单权限、时间范围、同步延迟和状态字段
口令解析、剪贴板识别、短链、CMS 链接 interfaces/口令与工具接口.md 区分普通接口和增值类接口的鉴权方式
外卖、到店、酒店、出行、票务、本地生活 interfaces/本地生活接口.md 提醒美团、淘宝闪购、本地生活等特殊权限

一句话总结

下载文档包 → 导入 AI → 按意图查分类文档 → 输出接口、鉴权和排错入口。

下载文档包
下载链接已复制