智能监控系统

1. 前言：

2. 交互时序图：

3. 请求场景：

智能设备监控系统

4. 接口要求：

使用来伊份openapi加密协议进行加密请求

5. 接口标准

5.1 基本信息

描述	值
服务名称	device-monitor-app-api
URL	测试环境：https://openapi.test.laiyifen.com/device-monitor-app-api/device/v1/monitor/receive 生产环境(已上线)：https://openapi.laiyifen.com/device-monitor-app-api/device/v1/monitor/receive
认证方式	令牌
请求方式	HTTP(POST)
功能描述(适用场景)	接收设备信息事件接口详情

5.2 请求头公共参数 （Header）

参数名字	参数类型	是否必须	说明
X-Co-Client	String	是	客户端Id（来伊份提供）
X-Co-Sign	String	是	签名
X-Co-TimeStamp	String	是	签名时间戳

5.3 入参 Body

参数名字	参数类型	是否必须	说明
deviceId	Integer	是	设备id 咖啡机： 2 制冰机：37
deviceBrandCode	String	是	设备品牌code（对接后来伊份提供）
deviceTypeCode	String	否	设备型号code（对接后来伊份提供)
deviceUniqueCode	String	是	设备编码
shopCode	String	是	门店code
indexId	Integer	是	监控指标id 开关机状态 23 咖啡系统是否需要清洗片 清洗 24 咖啡豆量是否正常 25 咖啡机是否需要除垢 26 冰机在线状态 27
status	String	是	指标状态：0正常 1异常

5.4 入参示例

{
  "deviceBrandCode":"BTB",
  "deviceId":2,
  "deviceTypeCode":"BTB-103+1",
  "deviceUniqueCode":"201111110",
  "indexId":23,
  "shopCode":"107U",
  "status":0
}

5.5 返回统一参数

参数名字	参数类型	是否必须	说明
code	String	是	返回请求业务代码
msg	String	是	返回信息描述
data	Json	是	返回参数

5.6 返回示例

{
  "code": "0",
  "msg": "成功"
}   

5.7 对接流程

1. 供应商提供设备品牌名称，设备型号名称，设备编码等信息预先录入监控系统后生成相应code（如果供应商有对应code可以一起提供 后续使用供应商提供code）。
2. 供应商设备指标 正常/异常 时调用接口（deviceId，deviceBrandCode，deviceTypeCode，deviceUniqueCode，indexId字段为来伊份提供给供应商调用）