wms-3代货架标签系统（四个灯供电版本）接口文档

一、查询标签信息接口

接口类型：POST, 参数格式：json array

链接形式：

http://localhost/wms/associate/getTagsMsg

代码形式：

{

url : http://localhost/wms/associate/getTagsMsg,

requestMethed : GET,

requestParameter : {

 } ,

response : {

[

    {

        "lastOpreateTime": "2020-09-23 03:39:06",

        "mac": "99.97.44.47",

        "power": 100,

        "routerid": "CWR000001",

        "rssi": -50,

        "showStyle": "Pick Template"

    },

    {

        "lastOpreateTime": "2020-09-23 03:39:08",

        "mac": "99.97.44.60",

        "power": 100,

        "routerid": "CWR000001",

        "rssi": -43,

        "showStyle": "Pick Template"

}

]

}

请求参数介绍:

本地服务器用 localhost, 非本地则将 localhost 改为服务器所在主机 IP 地址

响应参数介绍: json array

参数	数据类型	功能	描述
lastOpreateTime	string	最后操作（添加修改）时间	最后操作（添加修改）时间
mac	string	标签id	标签id
power	int	电量	标签剩余电量
routerid	int	所属基站Id	所属基站id号
rssi	int	信号强度	信号强度
showStyle	string	显示样式	该标签屏幕显示的样式

二、更新墨水屏接口

接口类型：POST, 参数格式：json array

链接形式：

http://localhost/wms/associate/getTagsMsg

代码形式：

{

url : http://localhost/wms/associate/getTagsMsg,

requestMethed : GET,

requestParameter : {

 } ,

response : {

[

    {

        "lastOpreateTime": "2020-09-23 03:39:06",

        "mac": "99.97.44.47",

        "power": 100,

        "routerid": "CWR000001",

        "rssi": -50,

        "showStyle": "Pick Template"

    },

    {

        "lastOpreateTime": "2020-09-23 03:39:08",

        "mac": "99.97.44.60",

        "power": 100,

        "routerid": "CWR000001",

        "rssi": -43,

        "showStyle": "Pick Template"

}

]

}

请求参数介绍:

本地服务器用 localhost, 非本地则将 localhost 改为服务器所在主机 IP 地址

响应参数介绍: json array

参数	类型	功能	描述
mac	string	标签mac地址	需要更新的标签mac地址
mappingtype	int	字段映射关系	字段映射关系类型，默认1
styleid	int	模板样式ID	选择实际样式ID，默认1
outtime	int	亮灯超时时间	协议兼容，填写固定值；实际不会控制指示灯灯；
ledstate	int	控制标签指示灯状态	协议兼容，填写固定值；实际不会控制指示灯；
ledrgb	string	控制指示灯的颜色	协议兼容，填写固定值；实际不会控制指示灯；
cmdtoken	string	在对应反馈中传出	扩展参数，可不传
储位号	string	储位号	参数名可以自定义
料号	string	料号	参数名可以自定义
品名	string	品名	参数名可以自定义
数量	string	数量	参数名可以自定义
二维码	string	二维码内容	参数名可以自定义

注：显示参数可修改，多灯电子标签，该接口不支持亮灯，只会刷屏

三、墨水屏更新结果反馈

接口类型：POST, 参数格式：json object

代码形式：

{

requestMethed:POST,

requestParameter:{

{"mac":"99.99.08.51","power":100,"result":true,"cmdtoken":"22222","message":"数据成功"}

},

response:{

}

}

响应参数介绍:

参数类型：json object

参数	数据类型	功能	描述
mac	string	触发按键的标签mac地址	触发按键的标签mac地址, 99.99.01.01
power	int	墨水屏标签电量	更新数据库墨水屏电量, 100
result	bool	墨水屏更新结果	true ：更新成功；false：更新失败；
cmdtoken	string	返回调用请求传入的cmdtoken
message	string	更新结果信息描述	数据成功；数据失败；数据发送超时；唤醒失败；基站不在线；数据异常；数据格式不正确，解析失败；参数格式不正确或参数不全，无法执行标签不存在；

四、拣货完成按标签确认键反馈接

接口类型：POST, 参数格式：json object

代码形式：

{

requestMethed:POST ,

requestParameter:

{

{"mac":"99.99.17.1","result":1}

},

response:{

}

}

参数格式：json object

参数	数据类型	功能	描述
mac	string	标签mac地址	指示灯所在标签的mac地址
result	int	按键反馈结果	result=1，右1按键；result=2，左1按键；result=3，左2按键；result=4，左3按键；

五、多灯标签单独点灯控制接口

接口类型：POST, 参数格式：json array

http://localhost/wms/associate/ctrlTagLed 

代码形式：

{

url :http://localhost/wms/associate/ctrlTagLed ,

requestMethed : POST,

requestParameter:{

[

{

"mac":"99.99.08.51",

"lednum":1, 控制哪个灯(1~4)

"timeout":60,

"ledrgb":"ff00",

"ledmode":0, 闪亮灯模式：0，常亮1快闪，2慢，3灭灯

"cmdtoken":"33333",

"reserve":"reserve"

},

{

"mac":"99.96.19.64",

"lednum":1, 控制哪个灯(1~4)

"timeout":60,

"ledrgb":"ff00",

"ledmode":0, 闪亮灯模式：0，常亮1快闪，2慢，3灭灯

"cmdtoken":"44444",

"reserve":"reserve"

}

]

response:{

true

}

}

（此链接包含特殊字符”[” ”]”）请求参数介绍:

本地服务器用 localhost, 非本地则将 localhost 改为服务器所在主机 IP 地址

请求参数介绍: json array

本地服务器用localhost, 非本地则将localhost改为服务器所在主机IP地址

参数	数据类型	功能	描述
mac	string	标签mac地址	指示灯所在标签的mac地址
lednum	int	指示灯的编号	需要控制哪个指示灯（编号：1~4）
timeout	int	亮灯超时时间	对应时间多少秒后标签自动熄灭；默认传0不自动熄灭
ledrgb	string	亮灯颜色	Rgb颜色值：红色，ledrgb =“ff0000”;绿色，ledrgb=“ff00”;蓝色，ledrgb=“ff”;黄色，ledrgb=“ffff00”;白色，ledrgb=“ffffff”;紫色，ledrgb= “ff00ff”;淡蓝，ledrgb= “ffff”;
ledmode	int	亮灯模式	0：标签指示灯常亮；1：标签指示灯快闪；2：标签指示灯慢闪；3：灭灯；4：全灭；
cmdtoken	string	在对应反馈中传出	扩展参数，可不传
reserve	string	预留	预留

response响应参数介绍:

参数	功能	描述
bool	调用接口响应	false：调用失败；true：调用成功；

注：显示参数可修改

六、多灯标签单独点灯结果反馈

接口类型：POST, 参数格式：json object

代码形式：

{

requestMethed:POST,

requestParameter:{

{

"mac":"99.99.08.51",

"result":true,

"power":100,

"lednum":1,

"cmdtoken":"55555",

"message":"数据成功"

}

},

response:{

}

}

响应参数介绍:

参数类型：json

参数	数据类型	功能	描述
mac	string	标签mac地址	指示灯所在标签的mac地址
power	int	不处理	不处理
result	bool	点亮完成反馈结果	false，点亮失败；true，点亮成功；
lednum	int	指示灯ID	指示灯1，lednum=1指示灯2，lednum=2指示灯3，lednum=3指示灯4，lednum=4
cmdtoken	string	返回调用请求传入的cmdtoken
message	string	更新结果信息描述	数据成功；数据失败；数据发送超时；唤醒失败；基站不在线；数据异常；数据格式不正确，解析失败；参数格式不正确或参数不全，无法执行标签不存在；

七、巷道灯控制

接口类型：POST, 参数格式：json array

http://localhost/wms/associate/ctrlShelfIndicator  

代码形式：

{

url :http://localhost/wms/associate/ctrlShelfIndicator

requestMethed : POST,

requestParameter:{

[

{

"mac":"99.99.08.51",

"timeout":60,

"ledrgb":"ff00",

"ledmode":0,

"buzzer":1,

"reserve":"reserve"

},

{

"mac":"99.96.19.64",

"timeout":60,

"ledrgb":"ff00",

"ledmode":0,

"buzzer":1,

"reserve":"reserve"

}

]

response:{

true

}

}

（此链接包含特殊字符”[” ”]”）请求参数介绍:

本地服务器用 localhost, 非本地则将 localhost 改为服务器所在主机 IP 地址

请求参数介绍: json array

本地服务器用localhost, 非本地则将localhost改为服务器所在主机IP地址

参数	数据类型	功能	描述
mac	string	要点亮标签ID	标签设备ID号
timeout	int	亮灯超时时间	对应时间多少秒后标签自动熄灭
ledrgb	string	亮灯颜色	(异常报警）红：ff0000,（出库）绿：ff00；（入库）黄：ffff00,
ledmode	int	亮灯模式	0：常亮；1：快闪；2：慢闪；3灭灯,4全灭
buzzer	int	蜂鸣器状态	1：响，2：不响
reserve		预留	预留

响应参数介绍:

参数	数据类型	功能	描述
bool	点亮数据发送指示	点亮数据发送指示	true：发送成功；false：发送失败；

注：显示参数可修改

八、巷道灯结果反馈

接口类型：POST, 参数格式：json object

代码形式：

{

requestMethed:POST,

requestParameter:{

{"mac":"99.99.08.51","result":true}

},

response:{

}

}

响应参数介绍:

参数类型：json object

参数	数据类型	功能	描述
mac	string	要点亮指示灯ID	指示灯备ID号
result	bool	反馈结果	true, 点亮成功； false, 点亮失败；

九、反馈回调地址设置

Admin用户登录到wms系统，进入“系统管理->第三方配置界面”，可以配置反馈接口的回调地址

反馈类型	描述	地址
墨水屏更新结果反馈	updateTagResult	回调完整URL
拣货完成确认键反馈	enterKey	回调完整URL
三色货架指示灯结果反馈/单独点灯结果反馈	ctrlShelfIndicatorResult	回调完整URL