ERP API 如何对接(开放 API 能力)

这篇教程解决什么问题

当你想让自建系统、脚本或 AI 智能体直接调用旺销王 ERP 的数据和操作时,不需要再从页面上复制粘贴,也不需要模拟点击。开放 API 提供了一条受权限控制的通道:你在「系统 > 开放API管理」里创建 AccessToken,再按「API能力说明」里的接口文档发起请求即可。

本教程对应页面:系统 > 开放API管理 > API能力说明 > API,适用于第一次接入 ERP 开放 API 的开发者或运营人员。

开始前先准备三样东西

  1. 一个可用的旺销王 ERP 账号:用主账号或已获授权的子账号登录。
  2. 确认套餐和调用额度:开放 API 按账号计算每日调用次数,页面顶部会显示今日调用量;套餐不支持时页面会提示升级。
  3. 一个 AccessToken:它是调用接口的钥匙,等同于账号在该权限范围内的访问凭证,不要发到公开群、截图或前端代码里。

第 1 步:进入开放API管理

登录 ERP 后,打开「系统 > 开放API管理」。页面顶部是今日 API 调用量,下面是「API能力说明」「AccessToken管理」「Skill市场」等页签。

第一次接入建议先看「API能力说明」,确认要用的能力是否已经开放,再去创建 Token。

第 2 步:创建 AccessToken

  1. 切换到「AccessToken管理」,点击「创建AccessToken」。
  2. 填写一个能看懂用途的名称,例如「订单查询机器人」「刊登助手」。
  3. 选择权限范围。只勾选这次真正需要的能力,不要一次性全选。
  4. 创建成功后立即复制 Token 并保存到安全位置。Token 通常只在创建时完整展示一次,关闭后无法再次查看。

建议按用途拆分 Token:查询订单的和修改商品的不要共用一个,出问题时可以单独停用,不影响其他业务。

第 3 步:在「API能力说明 > API」找到要调用的接口

  1. 切换到「API能力说明」,在上方选择「API」。
  2. 左侧是能力分类(产品、订单、库存、物流、报表等),点击分类后右侧列出该分类下的开放接口。
  3. 列表包含「开放API路径」「名称」「说明」「模块」「文档地址」。可以直接在搜索框输入功能名称或路径关键字。
  4. 点击接口路径或「查看」,会打开该接口的文档页,里面有请求方式、入参、出参和请求示例。
  5. 如果要把能力交给 AI 智能体,点击顶部「复制 Skill Manifest 地址」,把地址配置到智能体侧,让它自己读取能力清单。

第 4 步:发起第一次调用

所有开放 API 都使用同一个域名(你的 ERP 访问域名),路径以文档中的「开放API路径」为准。请求头需要两项:

Content-Type: application/json
AccessToken: 你的真实Token

以「查询产品列表」为例,接口路径是 /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 条数据,适合第一次验证连通性;确认返回正常后再改成分页、筛选等更复杂的条件。

第 5 步:读懂返回结果

开放 API 统一返回 JSON,核心字段是:

  • success:是否成功。判断成败要看这个字段,不要只看 HTTP 状态码。
  • message:成功时通常是成功标识,失败时是原因说明。
  • data:业务数据;不同接口结构不同,以文档的出参定义为准。

如果返回 success:false,先按 message 排查:Token 是否填错或已停用、权限范围是否包含该能力、当天调用额度是否用完、参数类型和必填项是否符合文档。

第 6 步:接入自己的系统或 AI 智能体

  1. 把 AccessToken 放在服务端的安全配置里,不要写进浏览器前端、公开仓库或聊天记录。
  2. 按「能力分类」逐个核对接口文档,先接只读查询,再接写入类操作。
  3. 涉及发布、发货、改库存等动作时,先做小批量验证,并在业务侧保留人工确认。
  4. 定期查看「今日调用」和调用统计,发现异常调用先停用对应 Token。
  5. 给 AI 智能体使用时,把 Skill Manifest 地址和 Token 分开配置:Manifest 告诉它能做什么,Token 决定它能以哪个账号、哪些权限访问。

常见问题

  • 提示未授权或 Token 无效:检查请求头名称是否为 AccessToken,值是否复制完整,Token 是否已被停用或删除。
  • 提示无权限:回到「AccessToken管理」确认该 Token 的权限范围包含要调用的能力;权限调整后建议重新创建 Token 验证。
  • 提示调用次数超限:开放 API 有每日配额,等次日恢复或调整套餐;调试时先用小分页、少字段,避免无意义的高频轮询。
  • 参数总是不对:以接口文档页的入参定义和请求示例为准,注意字段大小写、必填项和分页参数。

一句话记住

先在「AccessToken管理」拿到钥匙,再到「API能力说明 > API」按文档调用;Token 只给必要的权限,先只读、后写入,成败看 success。

기사 공유