2.1 HTTP推送
第三方实现API接口由HAI平台主动发送调用此HTTP接口向对接方推送末端设备的数据
2.1.1 第三方对接实现
1.需要实现一个HTTP接口来接收HAI平台推送的数据。
HTTP的接口要求如下:
- 现场HAI平台服务器与第三方对接服务器之间的网络是通的
- POST方式实现
- 数据载体在body 格式为json字符串, HAI平台HTTP调用API header中会添加以下参数 Content-Type=application/json 数据则携带在body中
- HAI平台调用此API时暂不支持增加认证信息, 第三方实现API时若有验证会出现收不到数据问题
- 对接方API服务收到HAI平台推送数据应即刻回复HAI平台,回复之后再去处理数据回复消息可自定义或者空 HTTP状态码一定要为200，HAI平台会在收到200状态码后，才会继续推送下一个数据包。
- 如果HAI平台调用第三方API出现多次延迟(超2秒)返回或者返回非200状态码会触发延迟机制,延迟机制状态下可能会推送数据会与末端设备状态对应不上或者控制失败等问题
2.联系现场调试人员给出HTTP API调用地址如: http://192.168.0.1:80/api/data/push 此地址为举例地址请现场调试同事勿将此地址直接填写到项目中
3.现场调试人员沟通如果HAI平台对接已经建立完成需要第三方验证对接数据是否收到,确认无误之后解析对接数据
4.解析数据需要用到现场调试人员导出的设备点位与说明excel字段, 请联系现场调试人员索要对接字段文档
5.对接数据解析注意事项
- excel中设备列表Sheet为HAI平台设备, 每一行代表一个设备, 设备唯一标识为"唯一UDID"字段
- 设备列表中的"设备型号编码"请重点关注, 每种设备型号所具备的点位信息可能不同, 具体点位描述在其他Sheet中查找与设备型号编码一致的点位描述Sheet
- 点位描述的Sheet 中所描述的为设备的devices_json_object 字段, 具体的点位名称与描述请参考excel中对应的Sheet
- 因一种设备型号编码代表一种类型的设备, 每种型号的设备具备的点位可能不同(例如温控器与水电表) 所以需要对接方自行判断型号队形的点位功能(请使用设备型号编码判断,不要使用设备型号ID, ID会发生变化)
- 授权码Sheet中所描述的授权码字段只有在设备控制时才会用到, 如果第三方对接不需要控制设备可以忽略此Sheet
2.1.1 现场调试人员实现
1.所有对接设备录入完成,网关可以没调试设备可以为离线状态,但是平台一点要将对接设备全部录入在进行操作否则导出点位会出现缺漏
2.联系第三方对接人员索要上报url地址, 如第三方还未实现可以要求先给出先创建对接,第三方按照给出的地址实现完成即可
3.现场调试人员登录到HAI平台, 点击左侧菜单 系统管理 数据对接 点击创建数据对接
对接信息填写
选择需要对接设备(未被选择的设备将不会被推送到第三方))
确认提交开始对接
点击提交完成, 测试对接是否能推送到第三方
校验失败:
校验成功:
导出设备列表与设备协议注意:导出后此文件需要给到第三方对接,
如果此时对接设备还没有全部录入需要后续添加操作时在导出给到第三方对接
