ERP API 如何对接(开放 API 能力)
关键词 开放API API对接 AccessToken ERP API 开放接口
本教程适用于「系统 → 开放API管理 → API能力说明」页面,用于把旺销王 ERP 的开放接口接入自建系统、脚本或 AI 智能体。不包含各电商平台官方接口的代理调用,平台接口请参阅《平台接口如何对接(以 AliExpress 为例)》。
开始前确认
- 已用拥有开放 API 权限的账号登录 ERP,主账号或已获授权的子账号均可。
- 已确认当前套餐支持开放 API,并了解账号的每日调用额度;页面顶部会显示今日调用量。
- 已准备一个可用的 AccessToken,作为调用接口的访问凭证。
进入开放API管理
登录 ERP 后,打开「系统 → 开放API管理」。页面顶部是今日 API 调用量,下面是「API能力说明」「AccessToken管理」「Skill市场」等页签。
- 第一次接入先停留在「API能力说明」,确认要用的能力是否已经开放。
- 确认能力可用后,再切到「AccessToken管理」创建令牌。
【推荐截图:开放API管理页面顶部,含今日 API 调用量与「API能力说明 / AccessToken管理 / Skill市场」页签】
创建 AccessToken
- 切换到「AccessToken管理」,点击 创建AccessToken。
- 填写一个能看懂用途的名称,例如「订单查询机器人」「刊登助手」。
- 选择权限范围。只勾选这次真正需要的能力,不要一次性全选。
- 创建成功后立即复制 Token 并保存到安全位置。
找到要调用的接口
- 切换到「API能力说明」,在上方选择「API」。
- 左侧是能力分类(产品、订单、库存、物流、报表等),点击分类后右侧列出该分类下的开放接口。
- 列表包含「开放API路径」「名称」「说明」「模块」「文档地址」。可以直接在搜索框输入功能名称或路径关键字。
- 点击接口路径或「查看」,打开该接口的文档页,里面有请求方式、入参、出参和请求示例。
发起第一次调用
所有开放 API 都使用同一个域名(你的 ERP 访问域名),路径以文档中的「开放API路径」为准。请求头需要两项:
| 请求头 | 值 | 说明 |
|---|---|---|
Content-Type | application/json | 固定使用 JSON 请求体。 |
AccessToken | 你的真实Token | 在「AccessToken管理」中创建,注意大小写。 |
以「查询产品列表」为例,接口路径是 /open-api/product/get_list,请求方式为 POST:
curl -X POST 'https://你的ERP域名/open-api/product/get_list' \
-H 'Content-Type: application/json' \
-H 'AccessToken: 你的真实Token' \
-d '{"platform":"Shopee","page":1,"page_size":1}'
参数含义以接口文档为准。上面这个例子只读取 1 条数据,适合第一次验证连通性;确认返回正常后,再改成分页、筛选等更复杂的条件。
读懂返回结果
开放 API 统一返回 JSON,核心字段是:
success:是否成功。判断成败要看这个字段,不要只看 HTTP 状态码。message:成功时通常是成功标识,失败时是原因说明。data:业务数据;不同接口结构不同,以文档的出参定义为准。
常见报错与处理方式如下:
| 返回提示 | 常见原因 | 处理方式 |
|---|---|---|
| 未授权或 Token 无效 | 请求头名称写错、Token 未复制完整、Token 已停用或删除。 | 检查请求头是否为 AccessToken,重新复制或创建 Token。 |
| 无权限 | Token 的权限范围不包含要调用的能力。 | 回到「AccessToken管理」调整权限,或重新创建 Token 验证。 |
| 调用次数超限 | 当天开放 API 配额已用完。 | 等次日恢复或调整套餐;调试时使用小分页、少字段。 |
| 参数不正确 | 字段大小写、必填项或分页参数与文档不一致。 | 以接口文档页的入参定义和请求示例为准逐项核对。 |
接入自己的系统或 AI 智能体
- 把 AccessToken 放在服务端的安全配置里,不要写进浏览器前端、公开仓库或聊天记录。
- 按「能力分类」逐个核对接口文档,先接只读查询,再接写入类操作。
- 涉及发布、发货、改库存等动作时,先做小批量验证,并在业务侧保留人工确认。
- 定期查看「今日调用」和调用统计,发现异常调用先停用对应 Token。
- 给 AI 智能体使用时,把 Skill Manifest 地址和 Token 分开配置:Manifest 告诉它能做什么,Token 决定它能以哪个账号、哪些权限访问。
完成检查
- 「AccessToken管理」中已生成可用的 Token,权限范围与本次要调用的接口一致。
- 「API能力说明 → API」中能找到目标接口,并已核对请求方式、入参和出参。
- 用文档示例发起一次调用,返回
success:true,且data中有预期数据。 - Token 已保存在服务端,没有出现在前端代码、公开仓库或聊天记录中。