[TOC] ## **开放平台对接的总体流程**  开放平台对接的总体流程如下图所示。  流程步骤介绍如下： 1. 客户申请：客户向我司提出对接申请，说明都需要对接哪些功能。 2. 客服授权：我司客服为客户在其使用的电梯物联网平台分配第三方接入的相关角色，完成功能授权。 3. 平台配置：授权成功后，客户可自行在平台设置用于对接的第三方的身份信息（appkey-第三方身份标识、appSecret-计算签名所需的加密因子）以及完整的请求地址信息、回调地址等。 操作步骤： 进入工作台，单击“接入平台 > 第三方接入管理”，单击“添加”按钮，生成客户对接信息。  4. 客户开发、联调：客户根据拿到的技术资料进行开发，我司研发人员按需与客户联调，直到客户功能上线。 其中对接文档资料可从“接入平台 > 第三方接入管理”中单击“API文档”进行下载。  5. 正式使用：对接完成，客户正式使用。 ## **API平台目前支持的功能** 为保证核心功能的正常数据交互，开放平台提供以下接口供第三方调用： ### 基础功能 - 获取token信息 非常重要，token用于接口调用时的身份校验及权限控制，除事件转发外，其余核心功能接口在调用时均要求传递token。 - 获取采集设备信息 向第三方返回其名下的采集设备信息，获取实时数据、实时音视频时，需传递该接口返回的设备的关键参数。 - 设置回调地址 回调地址是指一个完整的、可访问的http或https接口地址，当设备发生故障时，开放平台回调用此接口，向第三方发送故障信息。第三方可通过第三方接入管理功能或者接口调用方式修改回调地址。 ### 核心功能 目前，开放平台对外提供以下核心业务功能： - 电梯档案 通过接口调用方式向第三方返回电梯的基本档案信息，包括电梯基础信息、电梯出厂信息、电梯安装信息、电梯维保信息。 - 获取设备实时数据 通过websocket长连接方式向第三方实时推送电梯的运行数据，如楼层、上下行等。 - 事件（故障）转发 如果第三方已经设置过回调地址，设备上报故障（事件）后，开放平台会将组装好的故障（事件）数据通过回调接口发送给第三方。 - 实时视频预览和历史回放视频预览 如果电梯已绑定摄像头，则可根据电梯注册代码或者电梯绑定的智能硬件网关注册代码查看对应的实时视频以及历史回放视频。 ## **重要功能点的对接流程** 开放平台支持的功能中，几个比较重要的功能有：获取目标设备实时数据、事件（故障）转发，下面对其进行逐一介绍。 ### 获取设备实时数据 该功能采用websocket长连接的方式实现，具体的接口调用流程如下图所示。  >注： 1.每个websocket实例支持请求多台设备的多种类型的实时数据，按要求发送请求参数即可。 2.考虑到平台的稳定性以及数据传输的及时性，每个客户每个weboscket连接下同时请求实时数据的设备的tag数不能超过20台；每个客户同时请求实时数据的设备的tag数不能超过100台。 3.为防止流量超限，对于连接超过0.5个小时（暂定）websocket，开放平台会自动断开连接。 ### 事件（故障）转发 该功能不需要客户主动调用接口，当设备发生故障（事件）时，API平台会通过第三方预先设置好的回调地址将故障信息发送给第三方。以下是推送的各类事件的详细描述： 1. 手动呼救（2号事件）：物联网模块实时采集电梯信息，当发生紧急事件时，乘客在轿厢内按下紧急呼叫按扭，按扭被按下超过2秒，上报手动呼救事件，1分钟内不重复上报； 2. 自动呼救（3号事件）：物联网模块实时采集电梯信息，当监测到电梯发生困人时，会触发困人事件进行上报； 3. 综合故障（6号事件）：物联网模块实时采集电梯信息，当监测到电梯发生故障时，会触发综合故障事件进行上报； 4. 检修状态（7号事件）：物联网模块实时采集电梯信息，当监测到电梯发生检修时，会触发检修状态事件进行上报； 5. 电梯停电（8号事件）：物联网模块实时采集电梯信息，当监测到电梯发生停电时，会触发电梯停电事件进行上报； 6. 电话告警（9号事件）：在物联网平台给电梯配置接警号码，并且该梯已启用普通通话模式。发生紧急情况时，通过按下紧急呼叫按钮，向外拨打电话，会触发电话告警事件上报； 7. 通信异常（11号事件）：物联网模块实时采集电梯信息，短时间内，当物联网模块与电梯主控板无法建立正确的通信，上报通信异常。当物联网模块与电梯主控板长时间通信通信异常，为控制器未连接； 8. 云总机通话（12号事件）：在物联网平台给电梯配置接警号码，并且该梯已启用云总机通话模式。发生紧急情况时，通过按下紧急呼叫按钮，向外拨打电话，会触发云总机事件上报。