产品接口协议

关于料架的对接:设备网关管理所有料架,料架对接都将由设备网关处理

扫码式对接:分为料架亮灯根据库位码控制(1.1接口)和全亮控制(1.2接口)

感应式入库对接流程:调用2.1接口,在物料放入库位后,接口将会返回入库结果

感应式出库对接流程:调用2.2接口立刻返回调用结果,料架亮灯,在取出物料之后,设备网关将会请求设置的数据推送接口(2.3接口),得到成功的反馈后完成出库

1:亮灯控制器接口

1.1:LED库位亮灯控制接口

接口名称

LED库位亮灯控制接口

服务提供方

设备网关接口服务

服务调用方

MES、WMS等系统

方式

HTTP-POST

URL

http://ip:8080/api/LedControl/ControlLEDByStoreCode

数据格式

Json

发送数据示例

{

"storeCodes":["0010001"],

"color":1,

"isBlink":false,

"lightSeconds":10

}

参数介绍

storeCodes:库位码(字符串数组),库位码由控制器序列号(001)+4位库位号组成(0001)

color:颜色,整型,1-7

isBlink:是否闪烁,布尔类型

lightSeconds:亮灯时间,整型,以秒为单位,设为0时常亮

返回结果

{

"result":true,

"msg":"成功",

"errormsg":"",

"data":null

}

参数介绍

result:结果

msg:信息

errormsg:错误信息

1.2:LED全部亮灯控制接口

接口名称

LED全部亮灯控制接口

服务提供方

设备网关接口服务

服务调用方

MES、WMS等系统

方式

HTTP-POST

URL

http://ip:8080/api/LedControl/ControlAllLED

数据格式

Json

数据示例

{

"serialNos":["001"],

"color":1,

"isBlink":false,

"lightSeconds":10

}

参数介绍

serialNos:控制器序列号(字符串数组)

color:颜色,整型,1-7

isBlink:是否闪烁,布尔类型

lightSeconds:亮灯时间,整型,以秒为单位,设为0时常亮

返回结果

{

"result":true,

"msg":"成功",

"errormsg":"",

"data":null

}

参数介绍

result:结果

msg:信息

errormsg:错误信息

2:感应式亮灯控制器接口

2.1:入库接口

接口名称

感应式入库接口

服务提供方

设备网关接口服务

服务调用方

MES、WMS等系统

方式

HTTP-POST

URL

http://ip:8080/api/RZTI/InStore

数据格式

Json

数据示例

{

"serialNo":"002",

"ucode":"12345678"

}

参数介绍

serialNo:控制器序列号

ucode:入库物品的唯一码

返回结果

{

"result":true,

"msg":"成功",

"errormsg":"",

"data":{"storecode":"0010001","storeid":1}

}

参数介绍

result:结果

msg:信息

errormsg:错误信息

data:返回入库的库位码、库位号

2.2:出库接口

名称

感应式出库接口

服务提供方

设备网关接口服务

服务调用方

MES、WMS等系统

方式

HTTP-POST

URL

http://ip:8080/api/RZTI/OutStore

数据格式

Json

数据示例

{

"ucodes":["1233234123"],

"store_codes":["0010001"],

"color":1,

"action":true,

"transId":"12345678"

}

参数介绍

ucodes:物品唯一码,字符串数组(保存库存信息时可用)

store_codes:库位码

color:出库指示颜色,整型,2-7

action:布尔类型,true出库,false取消出库

transId:出库回传携带的标识符

返回结果

{

"result":true,

"msg":"成功",

"errormsg":"",

"data":null

}

参数介绍

result:结果

msg:信息

errormsg:错误信息

2.3:出库数据回传接口

名称

感应式出库数据回传接口

服务提供方

MES、WMS等系统

服务调用方

设备网关接口服务

方式

HTTP-POST

URL

设备网关软件页面设置

数据格式

Json

数据示例

{

"ucode":"1233234123",

"storeCode":"0020001",

"storeid":1,

"transId":"12345678"

}

参数介绍

ucode:物品唯一码

storeCode:库位码

storeid:库位号

transId:出库回传携带的标识符

返回结果

{

"result":true,

"msg":"成功",

"errormsg":"",

"data":null

}

参数介绍

result:结果

msg:信息

errormsg:错误信息

2.4:取消报警

名称

取消报警接口

服务提供方

设备网关接口服务

服务调用方

MES、WMS等系统

方式

HTTP-POST

URL

http://ip:8080/api/RZTI/CancelAlarm

数据格式

Json

数据示例

{

"serialNo":"002",

"storeid":1,

"storeCode":"0020001"

}

参数介绍

serialNo:料架序列号或编码

storeid:库位号

storeCode:库位码(填写库位码时,选择库位码进行处理,为“”时选择serialNo、storeid参选进行处理)

返回结果

{

"result":true,

"msg":"成功",

"errormsg":"",

"data":null

}

参数介绍

result:结果

msg:信息

2.5:报警信息推送

名称

报警信息推送

服务提供方

MES、WMS等系统

服务调用方

设备网关接口服务

方式

HTTP-POST

URL

数据格式

Json

数据示例

{

"shelfno":"002",

"storeid":1,

"storeCode":"0020001"

"alarmtype":0,//0无报警,1入库报警,2出库报警

}

参数介绍

shelfno:料架序列号或编码

storeid:库位号

storeCode:库位码(填写库位码时,选择库位码进行处理,为“”时选择serialNo、storeid参选进行处理)

alarmtype:报警类型 0无报警,1入库报警,2出库报警

返回结果

{

"result":true,

"msg":"成功",

"errormsg":"",

"data":null

}

参数介绍

result:结果

msg:信息