Skip to content

接口文档

推送设备指令

长链接数据结构 {taskCode: xx,data: {xxx}} taskCode : 11 心跳 设备向系统发送
101 实时操作 系统向设备发送
 data:
  recordId: (发送记录id 待用)
  channel: (数字 仓位号)
  operate:
   1 (推杆开)
   2 (开锁)
   3 (电子秤标定/称校准)
   4 (推杆关)
   5 (臭氧开)
   6 (臭氧关)
   7 (解除DB故障)
   20 (仓外灯光关)
   21 (仓外灯光开)
102 参数设置 系统向设备发送
 data
  channel:
   仓位编号 0 表示所有仓参数相同,其他数字代表仓位号
    delayed: 人体感应延时
    smog: 烟雾报警
    Gripper: 夹手退出
    close: 关门时间
    push: 推杆保持时间
103 多媒体设置 系统向设备发送
 data
  model: change
104 走字灯 文字设置
 data
  content: “文字”
105 推送安卓升级包
 data
  fileName: 文件名
106 推送硬件升级包
 data
  fileName: 文件名
109 更换了规则
 data
110 用户扫码登录了 进入投放流程
 data
  member:会员id

设备主动推送API

1.设备激活

接口说明:设备激活,会通过设备sid生成唯一imei,并请求该接口,后端需要自行保存imei,并规范返回参数
接口地址:/MacDevice/register
请求方式:get
请求参数:

参数名类型参数说明
sidsting设备编号
imeistirng设备imei
latstring经度
lngstring维度
返回参数:
json
 {"code":200,"message":"激活成功","data":{"Rules":[{"id":112,"points":60,"code":1}]}}
参数名类型参数说明
codeint成功返回,统一code为200
messagestring返回信息
data/
rules/运营规则详情
pointsdecimal每kg获取积分数
codeint仓位id

2.设备登陆

接口说明:设备激活成功后,调用登录接口验证登录,并获取token,后续请求token放置于请求头中
接口地址:/MacDevice/login
请求方式:get
请求参数:

参数名类型参数说明
sidstring设备编号
imeistring设备唯一imei
返回参数:
json
{"code":200,"message":"操作成功","data":{"token": "xxxxx"}}
参数名类型参数说明
codeint成功返回,统一code为200
messagestring返回信息
data//
tokenstring用户自行生成token

3.设备socket长链接

接口说明:设备成功激活后自动链接socket长链接,后续设备控制均通过长链接进行指令推送
接口地址:/connectWebSocket/{sid}/{imei}
请求参数:

参数名类型参数说明
sidstring设备编号
imeistring设备唯一imei
返回参数:
json
 {"taskCode":112,"data":{"list":[{"channel":1,"maxWeight":180}]}}
参数名类型参数说明
taskCodeint长链接指令code
data/
list/仓位信息
channelint仓位id
maxWeightdecimel当前仓位最大重量

4.长链接设备心跳推送

接口说明:设备成功链接后,每30秒会推送当前重量,通过心跳判定当前设备是否在线
推送参数:

json
 {"data":{"weight":"0.0"},"taskCode":11}
参数名类型参数说明
taskCodeint长链接指令code
data/
weightstring当前重量

5.获取当前设备运营规则

接口说明:设备成功激活后,获取当前设备运营规则,用于大屏展示
接口地址:/MacDevice/setPrice
请求方式:post
请求参数:以form表单形式提交参数

参数名类型参数说明
serialNumberstring设备编号(同sid)
返回参数:
json
{"code":200,"message":"操作成功","data":0.60}
参数名类型参数说明
codeint成功返回,统一code为200
messagestring返回信息
datadecimel运营规则,/kg

6.添加当前版本固件

接口说明:推送当前固件版本,用户自行保存比对,升级
接口地址: /MacDevice/saveVersion
请求方式:post
请求参数:以form表单形式提交参数

参数名类型参数说明
versionstring设备软件版本
hardwareVersionstring设备硬件版本
返回参数:
json
{"code":200,"message":"操作成功","data":"修改设备版本号成功"}
参数名类型参数说明
codeint成功返回,统一code为200
messagestring返回信息
datastring信息体

7.用户输入手机号登录

接口说明:会员通过屏幕输入手机号登录
接口地址:/MacDevice/memberByPhone 请求方式:get
请求参数:

参数名类型参数说明
phonestring手机号
返回参数:
json
{"code":200,"message":"操作成功","data":{"member": {"id": "xxx"}}}
参数名类型参数说明
codeint成功返回,统一code为200
messagestring返回信息
data//
member/会员信息
idint会员id

8.图片上传

接口说明:订单投递时,拍摄图片并上传
接口地址:/MacDevice/upLoadImage
请求方式:post 请求参数:以form表单形式提交参数

参数名类型参数说明
fileMultipartFile图片文件
返回参数:
json
{"code":200,"message":"操作成功","data":"xxxxxxx"}
参数名类型参数说明
codeint成功返回,统一code为200
messagestring返回信息
datastring文件路径

9.订单上传

接口说明:订单投递完成后,订单上传接口
接口地址:/MacDevice/reportOrder
请求方式:post
请求参数:以form表单形式提交参数

参数名类型参数说明
memberIdint会员id
weightdecimal重量
picstring订单图片
warehouseint仓位id
wayint订单方式:0 无登录 1 刷卡 2 扫码 3 手机号 4 刷脸
msgstring该参数为空时为正常订单,该参数
不为空时,设备异常,携带异常信息
返回参数:
json
{"code":200,"message":"操作成功","data":{"points": "xxx"}}
参数名类型参数说明
codeint成功返回,统一code为200
messagestring返回信息
data//
pointsdecimal订单获取积分

10。管理人员后台登录

接口说明:管理人员进入设备后台
接口地址:/MacDevice/loginToBackstage
请示方式:post
请求参数:以form表单形式提交参数

参数名类型参数说明
userNamestring账号
pwdstring密码
返回参数:
json
{"code":200,"message":"操作成功","data":"登录成功"}
参数名类型参数说明
codeint成功返回,统一code为200
messagestring返回信息
datastring返回信息

11.满溢图片上传

接口说明:设备满溢探头识别仓位满溢,推送当前满溢图片
接口地址:/MacDevice/updateWarningPicture
请求方式:post
请求参数:以form表单形式提交参数

参数名类型参数说明
fileMultipartFile满溢图片
warehouseInteger满溢仓位id
返回参数:
json
{"code":200,"message":"操作成功","data":"保存成功"}
参数名类型参数说明
codeint成功返回,统一code为200
messagestring返回信息
datastring返回信息

12.上报告警

接口说明:设备报警上传
接口地址:/MacDevice/reportWarning
请求方式:post
请求参数:以form表单形式提交参数

参数名类型参数说明
warningTypeint告警类型 1 满溢报警 6 烟雾报警
warehouseInteger满溢仓位id
返回参数:
json
{"code":200,"message":"操作成功","data":"保存成功"}
参数名类型参数说明
codeint成功返回,统一code为200
messagestring返回信息
datastring返回信息