Skip to content

管理 API 授权 ​

更新时间:2026-09-23

1. 操作场景 ​

API 授权用于生成 ERP 与 GWMS 对接时需要的凭据。只有在 ERP 拿到这些凭据后,它才能把订单、商品等数据推送到 GWMS,或从 GWMS 拉取数据。

适用场景:

  1. 已确定要对接某个 ERP,需要在 GWMS 侧生成对接凭据。
  2. 需要在 ERP 侧填写凭据,但不知道从哪里获取。
  3. 某个 ERP 暂时不需要对接,或凭据疑似泄露,需要暂停它的访问权限。
  4. 对接中断,需要确认该 ERP 的授权是否处于启用状态。

不适用场景:

  1. 想新增一个可对接的 ERP 厂商。需先在 GWMS-平台管理-ERP授权 完成该 ERP 的授权。
  2. 想维护店铺在电商平台的授权。需到 GWMS-平台管理-授权店铺 处理。
  3. 想查看具体接口的请求格式、参数和返回字段。请查看开发者文档。

2. 操作指引 ​

前提条件 ​

请先确认以下条件:

  1. 当前账号可访问 GWMS-平台管理-API授权。
  2. 目标 ERP 已在 GWMS-平台管理-ERP授权 中完成授权,且状态为启用。
  3. 你已确认要对接的 ERP 名称,避免为一个不会使用的 ERP 生成凭据。

处理流程 ​

  1. 进入 GWMS-平台管理-API授权,确认列表中没有该 ERP 的授权记录。
  2. 点击【新增】,选择 ERP 并提交,系统自动生成该 ERP 的对接凭据。
  3. 在列表中复制 clientId、clientSecret、apiKey,并填写到 ERP 侧。
  4. 不需要对接时,点击【停用】暂停该授权。

2.1 进入 API 授权页面 ​

菜单路径:GWMS-平台管理-API授权

列表按客户代码分组展示,每组内一行对应一个 ERP,包含以下信息:

字段说明
客户代码授权所属的客户。列表按客户代码分组,同一客户下的多个 ERP 归为一组。
ERP 数量该客户已生成凭据的 ERP 个数。
ERP已授权的 ERP 名称。
clientIdERP 的客户端标识。
clientSecretERP 的客户端密钥。
apiKey客户侧的对接密钥。
创建时间凭据生成时间。
状态启用或禁用。

可按【ERP】和【状态】筛选记录。客户账号登录后不显示【客户代码】筛选项,列表只展示本客户的授权。

2.2 新增 API 授权 ​

  1. 点击【新增】,打开新增窗口。
  2. 在【ERP】下拉框中选择要对接的 ERP。
  3. 点击【确定】,系统为该 ERP 生成凭据,列表中新增一行记录。

下拉框中只会出现已经在 ERP 授权中启用的 ERP。如果找不到目标 ERP,请先到 GWMS-平台管理-ERP授权 完成该 ERP 的授权并确认其处于启用状态。

同一个 ERP 只需生成一次凭据。重复新增不会产生第二条独立记录,也不会刷新已有的凭据。

2.3 查看并复制凭据 ​

列表中每个凭据右侧都有复制按钮,点击即可复制完整字符串,无需手动选中。

  • apiKey:由客户在本页面生成,代表客户允许外部系统访问自己在 GWMS 的资源。例如 ERP 要向 GWMS 推送数据,就需要在 GWMS 生成 apiKey,再到 ERP 侧填写这个 apiKey。
  • clientId 与 clientSecret:对应所选 ERP 的客户端标识与密钥。这两个值由 ERP 厂商发放,按 ERP 分配,同一 ERP 下共用。

复制后请立即粘贴到 ERP 侧的对应配置项,并妥善保存。如果 clientId 或 clientSecret 显示为 -,说明该 ERP 尚未配置客户端凭据,请联系系统管理员。

2.4 停用与启用 ​

列表中每行的操作列提供【停用】或【启用】:

  • 授权处于启用状态时,显示【停用】。
  • 授权处于禁用状态时,显示【启用】。

点击后需要二次确认。停用会立即中断该 ERP 与 GWMS 的对接,该 ERP 推送或拉取数据的请求将不再被接受;重新启用后恢复。

当前版本不提供删除操作。某个 ERP 不再对接时,停用即可,不需要也无法删除这条记录。

3. 补充说明 ​

3.1 三个凭据的分工 ​

凭据由谁产生作用范围用途
apiKey客户在本页面生成当前客户标识并校验客户身份,决定外部系统可以访问该客户在 GWMS 的哪些资源
clientIdERP 厂商发放同一 ERP 共用标识接入的 ERP 系统
clientSecretERP 厂商发放同一 ERP 共用与 clientId 配套使用,校验 ERP 身份

ERP 侧通常需要同时填写这三个值。具体填在 ERP 的哪些配置项,以该 ERP 的对接说明为准。

3.2 状态说明 ​

状态含义对接是否可用
启用授权正常可用
禁用已停用不可用,请求被拒绝

3.3 凭据安全 ​

  • 三个凭据等同于账号密码,取得凭据即可以客户身份访问 GWMS 资源。不要通过聊天工具、邮件正文或截图公开传播。
  • 人员变动或 ERP 侧配置人员变更时,建议重新评估是否需要保留原授权。
  • 怀疑凭据已泄露时,先在本页面【停用】该授权,阻断访问,再联系系统管理员处理后续更换事宜。

4. 常见问题 ​

Q1:新增时【ERP】下拉框里没有我要的 ERP,怎么办? ​

该 ERP 尚未在 ERP 授权中启用。请先到 GWMS-平台管理-ERP授权 完成授权,并确认状态为启用,再回到本页面新增。

Q2:可以重新生成或轮换 apiKey 吗? ​

当前版本不支持在本页面重新生成 apiKey。如需更换,请联系系统管理员处理。在更换前,可先【停用】该授权以阻断访问。

Q3:停用了某个 ERP 的授权,会影响已经在 GWMS 里的订单吗? ​

不会。停用只阻断该 ERP 与 GWMS 之间的接口访问,已经进入 GWMS 的订单、库存等数据不受影响,仍可在对应页面正常处理。

Q4:为什么同一客户下多个 ERP 的 clientId 是一样的? ​

clientId 和 clientSecret 由 ERP 厂商发放并按 ERP 分配,同一 ERP 下共用同一套客户端凭据。区分不同客户靠的是各自生成的 apiKey。

Q5:列表里的授权可以删除吗? ​

不支持删除。不再使用的授权请【停用】;停用后该 ERP 无法访问 GWMS,列表记录保留以便后续追溯和重新启用。