WMS_MAIN/methods/gateway.json

239 lines
11 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"module": "gateway",
"description": "内部网关接口,供内网系统间调用,统一使用 POST 请求",
"version": "0.2.0",
"updatedAt": "2026-03-29",
"headers": [],
"methods": {
"groups": [
{
"groupName": "用户模块",
"module": "user",
"list": [
{
"method": "user.getUserByTempCode",
"description": "根据绑定码反查WMS账号ID并写入扫码状态(扫描即视为已确认,状态缓存3分钟)",
"isNeedAuth": false,
"isNeedLogin": false,
"headers": [],
"params": [
{
"name": "code",
"type": "string",
"required": true,
"source": "body",
"description": "绑定码(由 user.getBindWechatCode 生成,6位字母数字混合)"
}
],
"response": [
{
"name": "account_id",
"type": "number",
"required": true,
"description": "匹配到的 WMS 账号ID"
},
{
"name": "real_name",
"type": "string",
"required": true,
"description": "WMS 账号表中的真实姓名,用于扫码绑定前确认账号"
},
{
"name": "status",
"type": "string",
"required": true,
"description": "当前扫码状态,成功扫码后固定为 scanned"
},
{
"name": "source",
"type": "string",
"required": true,
"description": "数据来源,如 scan-cache"
}
],
"errors": []
},
{
"method": "user.bindAccountByTempCode",
"description": "根据绑定码对应的扫码状态缓存将 ye4s 用户绑定到 WMS 账号(需先调用扫码反查接口)",
"isNeedAuth": false,
"isNeedLogin": false,
"headers": [],
"params": [
{
"name": "code",
"type": "string",
"required": true,
"source": "body",
"description": "绑定码(由 user.getBindWechatCode 生成,6位字母数字混合)"
},
{
"name": "ye4s_user_id",
"type": "number",
"required": true,
"source": "body",
"description": "ye4s 用户ID(例如扫码用户ID)"
}
],
"response": [
{
"name": "account_id",
"type": "number",
"required": true,
"description": "绑定目标 WMS 账号ID"
},
{
"name": "ye4s_user_id",
"type": "number",
"required": true,
"description": "被绑定的 ye4s 用户ID"
},
{
"name": "status",
"type": "string",
"required": true,
"description": "绑定状态,固定为 bound"
}
],
"errors": []
}
]
},
{
"groupName": "打印绑定模块",
"module": "print",
"list": [
{
"method": "print.getBindInfo",
"description": "根据 WMS 账号ID和扫码 code 返回可绑定仓库列表;有可绑定仓库时下发 300 秒临时凭据 tempCode,无可绑定仓库时返回空数组且不返回 tempCode",
"isNeedAuth": false,
"isNeedLogin": false,
"headers": [],
"params": [
{
"name": "account_id",
"type": "number",
"required": true,
"source": "body",
"description": "WMS 账号ID"
},
{
"name": "code",
"type": "string",
"required": true,
"source": "body",
"description": "打印端提供的绑定 code"
}
],
"response": [
{
"name": "warehouses",
"type": "array",
"required": true,
"description": "可绑定仓库列表,元素结构为 { id, name }"
},
{
"name": "tempCode",
"type": "string",
"required": false,
"description": "临时绑定凭据,仅当 warehouses 非空时返回"
}
],
"errors": [
{
"code": 0,
"message": "缺少有效参数 account_id 或 code"
},
{
"code": 0,
"message": "账号不存在或已禁用"
},
{
"code": 0,
"message": "无效code或未绑定"
}
]
},
{
"method": "print.bindByTempCode",
"description": "根据第一步返回的临时凭据执行打印台绑定,提交工作台名称和仓库ID后完成真实绑定",
"isNeedAuth": false,
"isNeedLogin": false,
"headers": [],
"params": [
{
"name": "temp_code",
"type": "string",
"required": true,
"source": "body",
"description": "第一步返回的临时凭据,300 秒有效"
},
{
"name": "printer",
"type": "string",
"required": true,
"source": "body",
"description": "工作台名称"
},
{
"name": "warehouse",
"type": "number",
"required": true,
"source": "body",
"description": "仓库ID"
}
],
"response": [
{
"name": "code",
"type": "string",
"required": true,
"description": "真实绑定 code"
},
{
"name": "printer",
"type": "string",
"required": true,
"description": "工作台名称"
},
{
"name": "warehouse",
"type": "number",
"required": true,
"description": "仓库ID"
},
{
"name": "computerId",
"type": "number",
"required": true,
"description": "打印台电脑ID"
}
],
"errors": [
{
"code": 0,
"message": "参数缺失"
},
{
"code": 0,
"message": "临时code无效或已过期"
},
{
"code": 0,
"message": "仓库无绑定权限"
},
{
"code": 0,
"message": "仓库id校验失败"
},
{
"code": 0,
"message": "该仓库下打印台名称已存在且可用"
}
]
}
]
}
]
}
}