蓝牙签到机接入协议

文档目标

本文档用于描述得力签到机设备与云端会议签到应用和巡检签到应用接入的标准方式、数据交换协议以及具体的接口定义。

适用范围

本文档用于说明得力云平台对外提供的得力签到机设备和云端会议签到应用、巡检签到应用服务接入方式,帮助和指导智能云考勤相关开发人员正确接入云平台。

会议签到接口设计

  • 接入流程

会议签到应用接入主要有两种途径:

1.  一是通过得力E+使用蓝牙连接设备,然后绑定相应应用服务;
2.  二是直接在App应用市场搜索并添加应用服务,然后扫描添加设备。
  • 云签到机功能

云签到机对比传统签到机而言,使用更为简单,不需要使用指定设备贴近签到机,签到机仅需要实现以下功能即可:

签到机固件升级;

签到机属于蓝牙设备,自身是无法联网检测固件版本以及下载固件。它使用蓝牙跟会议签到应用连接,设备将SN、版本号等信息发送给应用,应用来判断是否需要升级,如果需要升级则下载好相应固件通过蓝牙再发送给设备。

  • 会议签到应用功能

会议签到应用应至少具备以下功能:

1. 签到机管理;
2. 管理员同步;
3. 会议管理;

以上功能应在得力E+APP手机端和微信小程序分别针对终端用户和管理员进行实现,具体实现细节,这里不阐述。

为了便于考勤应用实现上述功能,平台应提供以下接口实现:

  • 应用安装通知

在组织管理员通过设备扫描或者主动安装应用时,平台会主动通过WebHook回调通知应用用户安装事件,回调应用指令为400。 考勤应用收到安装事件后,应启动初始化,通过数据同步指令507开始同步管理员数据。如果之前已有相关信息,则进行相应更新。

同样,当用户卸载删除了应用时,平台也会主动通知应用进行相应的数据清理操作,具体指令为401

  • 管理员同步

设备管理员同步是指会议签到应用与得力云平台之间同步设备管理员数据的过程,通过"用户组织更新通知406"和"组织信息同步507"应实现会议签到应用和得力云平台的一致性。

  • 设备绑定通知

当应用绑定或者解绑某台云签到机设备时,平台会通过指令402403回调通知应用服务设备相关信息,应用服务可进行相应的处理操作。

  • 设备名称更新

平台会通过应用端回调指令404同步设备状态到应用端,包含设备的名称。应用端根据业务实际需求来更改内部设备名称。

  • JSAPI接口

应用端以网页方式嵌入APP时,需要通过原生APP访问相关数据,因此,需要提供基于JS的一套API库方便应用调用,具体接口定义见《第三方云应用JS-SDK API说明》文档

  • APP消息推送

应用服务可通过平台向终端用户APP推送消息。

具体接口实现可参考应用接入协议指令501

更新日志

  • 1.0 (2018-5-18)

    1. 完善文档,定义接口