GWMS Public API
  1. auth
GWMS Public API
  • 使用Java SDK快速集成
  • auth
    • 获取访问令牌
      POST
  • Warehouses
    • 列出仓库
      GET
    • 获取仓库详情
      GET
  • Product SPUs
    • 列出产品SPU
      GET
    • 创建一个产品SPU
      POST
    • 通过SPU编码获取产品SPU
      GET
    • 通过SPU编码更新产品SPU(完整)
      PUT
    • 通过SPU编码删除产品SPU
      DELETE
  • Products
    • 列出产品
      GET
    • 创建一个产品
      POST
    • 批量创建产品
      POST
    • 通过SKU编码获取产品
      GET
    • 通过SKU编码更新产品(完整)
      PUT
    • 通过SKU编码更新产品(部分)
      PATCH
    • 通过SKU编码删除产品
      DELETE
  • Inbound Orders
    • 列出入库单
      GET
    • 创建入库单
      POST
    • 通过入库单号获取入库单
      GET
    • 通过入库单号更新入库单
      PUT
    • 通过入库单号取消入库单
      DELETE
    • 更新入库单状态
      PATCH
  • OutboundOrder
    • 创建出库单
      POST
    • 取消出库单
      POST
    • 分页查询出库单
      GET
    • 物流费试算
      POST
  • Stock
    • 查询产品库存
    • 分页查询产品库存
  • ExpressChannel
    • 获取所有物流渠道
  • Charge
    • 查询计费流水列表
  • Zones
    • 列出库区
    • 获取库区详情
  • Locations
    • 列出库位
    • 获取库位详情
  1. auth

获取访问令牌

POST
/auth-api/token
auth
使用客户端凭证(clientId + clientSecret)和API密钥获取JWT访问令牌。

认证流程详解#

1. 准备阶段#

系统管理员:为上游系统生成clientId和clientSecret
仓库用户:生成apiKey,关联到特定仓库和权限范围
上游系统:获取并安全存储这三个凭证

2. 令牌获取#

3. API访问#

安全最佳实践#

clientSecret安全:只在生成时显示一次,请妥善保存在安全的配置管理系统中
令牌管理:访问令牌有效期为1小时,建议在过期前5分钟重新获取
权限最小化:apiKey应只包含业务所需的最小权限范围
网络安全:生产环境必须使用HTTPS传输
日志安全:不要在日志中记录完整的凭证信息

错误处理#

400 Bad Request:请求参数缺失或格式错误
401 Unauthorized:凭证无效、过期或被禁用
429 Too Many Requests:请求频率超出限制
500 Internal Server Error:服务器内部错误

权限范围说明#

令牌的权限范围由apiKey关联的仓库用户权限决定:
权限范围说明示例操作
product:read产品数据读取查询产品列表、获取产品详情
product:write产品数据写入创建、更新、删除产品
warehouse:read仓库数据读取查询仓库、库区、库位信息
warehouse:write仓库数据写入创建、更新仓库配置
stock:read库存数据读取查询库存数量、库存明细
stock:write库存数据写入库存调整、库存转移
inbound:read入库单读取查询入库单列表、获取入库单详情
inbound:write入库单写入创建、更新、取消入库单
outbound:read出库单读取查询出库单列表、获取出库单详情
outbound:write出库单写入创建、更新、取消出库单

请求参数

Body 参数application/json必填

示例
使用有效的客户端凭证和API密钥获取访问令牌
{
    "clientId": "EOUSSQNWMRVX15GA",
    "clientSecret": "tiy3dbyW8l5W06sFQwsjOIU8-xTLbRJJVtxreGlka8Y=",
    "apiKey": "8MO5994KEQMEZMAN"
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
cURL
curl --location --request POST 'https://gwms.jmalltech.com/api-gateway/auth-api/token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "clientId": "EOUSSQNWMRVX15GA",
    "clientSecret": "tiy3dbyW8l5W06sFQwsjOIU8-xTLbRJJVtxreGlka8Y=",
    "apiKey": "8MO5994KEQMEZMAN"
}'

返回响应

🟢200成功
application/json
认证成功,返回访问令牌
Body

示例
{
    "access_token": "eyJraWQiOiI3ZTUxOWIwOS01ZWQ0LTRhZTctYjk4NS1lYWRlNjM0N2IzZDkiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIxOTI3OTgyMzMzNjI4MzcwOTQ1IiwiYXVkIjoiRU9VU1NRTldNUlZYMTVHQSIsInVzZXJfaWQiOiIxOTI3OTgyMzMzNjI4MzcwOTQ1IiwiYXBpX2tleSI6IjhNTzU5OTRLRVFNRVpNQU4iLCJzeXN0ZW1faWQiOiJnd21zLWRldiIsInZlbmRvciI6InRlc3RfdmViZG9yIiwic2NvcGUiOiJpbnZlbnRvcnk6cmVhZCBvcmRlcjpyZWFkIGFwaTpyZWFkIHdhcmVob3VzZTpyZWFkIiwiaXNzIjoiaHR0cHM6Ly9nd21zLmptYWxsdGVjaC5jb20vYXBpLWdhdGV3YXkvYXV0aC1hcGkiLCJleHAiOjE3NTMzNTQ4NzYsImlhdCI6MTc1MzM1MTI3NiwiY2xpZW50X2lkIjoiRU9VU1NRTldNUlZYMTVHQSJ9.lOIqdQdGEkAM8kX93sPYISHKqNuQZQnTwMoJIkOkBFRsCCyarMthOp5akFqyuI15c3odEpdgXWWpB6gN5Zk_ikU1OViG1mDMSvlTcoFkm6b65ocF_j6PXb8YxfdVRobcQPjN22lfy8XoB1DCLbmSQGptYdfmjRWflKw23fMoCJxcxZ26_bVtKOmywP8qBg3WwGSk8GB45QPsXxMOHCsdCx9lZkWNrMpmVk-Pa2d0vH8Ty1raA0HSWw7VixZNMwLfrDlGtEuxQZWBS_ohwfDCjhHewnKzt_n35FaLnt4CRikTp0UUt71TnpUU0nkt4sqWLiky3RlGxqaeRCqP8a1WGQ",
    "api_key": "8MO5994KEQMEZMAN",
    "user_id": "1927982333628370945",
    "system_id": "gwms-dev",
    "vendor": "test_vebdor",
    "scope": "inventory:read order:read api:read warehouse:read",
    "token_type": "Bearer",
    "expires_in": 3600,
    "client_id": "EOUSSQNWMRVX15GA"
}
🟠400请求有误
🟠401未认证
🟠429请求过多
🔴500服务器内部错误
修改于 2025-09-10 07:08:13
上一页
使用Java SDK快速集成
下一页
列出仓库
Built with