文档中心
智城云 文档中心

一、业务描述

随着物联网技术的普及,不少设备厂家在已经多个云平台接入自家产品,也有的设备厂家开始自建云平台,或者已经有成熟的APP。

智城云面向第三方云平台提供多种对接服务,满足第三方平台对智城云设备控制及数据分析需求。

图1-1 第三方对接业务图

1.1 方式1:智城云消息订阅

当企业仅需要获取设备在智城云上的状态数据,不需要实现对智能设备控制时,可通过智城云消息订阅的方式获取设备的实时属性、在线情况、故障、告警信息。

订阅后当设备状态变化时,智城云会将设备状态数据推送中订阅地址,企业可以根据设备数据进行分析。

注意:此方式不支持主动查询。

产品 功能 使用角色
设备属性变化上报 上报设备属性变化 第三方云端研发人员
设备在线状态上报 上报设备在线及离线状态 第三方云端研发人员
设备故障上报 上报设备故障 第三方云端研发人员
设备告警上报 上报设备告警 第三方云端研发人员

1.2 方式2:云对接

当企业需要将数据同步到指定云平台,并使用其该云平台的APP控制接入智城云的设备时,需要使用此方式对接。

此对接方式需要在第三方云APP上集成智城云配网SDK,或者将智能家居模块以插件形式集成到第三方业务APP中,来实现智能设备的添加绑定及控制。

产品 功能 使用角色
云端对接 配置鉴权信息,云对接接口研发等 第三方云端研发人员
智能家居插件 智能家居模块以插件形式集成在第三方业务APP中,通过该模块完成设备的绑定和控制 第三方云APP研发人员
配网SDK SDK集成在第三方APP中,主要功能是完成设备配网,设备控制功能由APP实现 第三方云APP研发人员

二、开通方法及资料

2.1 方式1:智城云消息订阅

企业自行开通,接入流程详见3.1。

2.2 方式2:云对接

本业务是针对云平台对接,第三云需适配智城云接口,接入前请详细阅读智城云云对云开放API

如果您是设备厂家,请同时向智城云和第三方云提出对接申请,确认第三方云能够遵循智城云云对接协议。

云对接时需要提供如下信息:

序号 名称 描述 说明
1 云名称
2 身份ID 智城云在第三方云的身份ID
3 身份秘钥 智城云在第三方云的身份ID配套的秘钥
4 URL地址 智城云调用第三方云时的域名信息
5 平台错误码 用于调用第三方云返回的错误码解析 双方平台错误码
6 智城云设备配网SDK及集成说明 智城云平台通用的设备配网SDK
7 智城云设备型号标识 设备所属型号在智城云平台上的唯一标识
8 智城云设备属性表 设备所属型号在智城云上的属性表

若第三方云有一套成熟的云对接方案,智城云也可以通过适配第三方云的方式完成云端对接。请联系您的商务经理了解详细情况。

三、接入流程

3.1 智城云消息消息订阅

图3-1 智城云消息订阅业务流程图

3.1.1 接口研发

1、企业平台开发者阅读接口文档自行研发数据接收功能。

接口位置:智城云文档中心–开放云平台–OpenAPI(企业版)中查看【数据回调类接口

图3-2 数据回调类接口文档位置


共四个接口,接口信息如下:

序 号 名称 描述 说明
1 设备上报数据回调 设备属性变化时,会将消息推送到此接口
2 设备上下线数据回调 设备在线状态变化时,会将消息推送到此接口
3 设备告警数据回调 设备触发告警时,会将消息推送到此接口 需在智城云企业平台导出告警配置
4 设备故障数据回调 智城云收到设备故障时,会将消息推送到此接口 需在智城云企业平台导出故障配置

2、 针对设备故障/告警数据,企业需要登录智城云企业管理平台,查看设备对应型号的故障/告警配置,接口只上报对应的故障码和告警ID,对应内容需要在第三方云上配置。

图3-3 故障配置页


图3-4 告警配置页


3、接口研发完成后,可在智城云企业平台配置对应的回调接口,智城云会自动验证接口是否有效。



图3-5 应用订阅页


4、接口配置完成后,当设备状态变化时,智城云会根据型号筛选本企业下的设备,并将设备数据推送到对应的接口,企业可以根据接收到的设备数据进行自定义分析。

3.2 云对接



图3-6 IOT对接业务流程图

3.2.1 云平台信息维护

在智城云与第三方云端分别配置鉴权信息,主要包括:

a. 云名称

在智城云创建第三方云名称,同时第三方云也需要维护智城云的信息;

b. 身份ID+秘钥

智城云需要维护两组信息:第三方云身份ID&秘钥、智城云身份ID&秘钥,同时第三方云也要维护这两组信息,作为鉴权依据。

c. 云接口URL

第三方云需要提供接口调用域名

智城云接口域名为https://cloudapi.zcyun.cn

d. 错误码信息

可提供错误码用于平台解析接口返回的code信息,若接口返回时附带描述,可不提供。

请将上述信息发送给您的智城云商务经理,智城云端配置将由智城云第三方云管理员完成。

3.2.2 云平台接口研发



图3-7接口概览


图中橙色代表智城云(受控云)提供的接口,绿色表示第三方云提供的接口。

任何云对云接口的业务调用均需要携带鉴权信息,首次调用业务接口前,第三方云平台需要先调用用户鉴权接口根据返回用户的鉴权信息(openId,openKey)完成业务接口调用。

在鉴权信息过期之前,调用业务接口前无需再调用鉴权接口。

第三方云需根据接口文档进行主云标准接口研发以及受控接口调用,如需智城云适配第三方云接口,请联系您的商务经理。

详细接口见云对云开放API

3.2.3 APP集成智城云SDK

第三方APP需集成智城云SDK,方可完成智城云设备的配网功能。



图3-9SDK工作流程


智城云SDK主要用于设备配网以及更新WiFi:

1.设备进入配网模式,第三方APP发起配网,调用智城云SDK;

2.SDK向设备发送WiFi信息,设备根据WiFi信息链接智城云;

3.SDK获取到设备ID信息;

4.SDK将设备信息同步给APP,APP根据获取到的信息以及自身配网逻辑,调用绑定接口。

3.2.4 第三方云配置设备型号及映射

第三方云根据智城云提供的设备属性表,创建型号及型号属性,若第三方云的属性规则与智城云不同,还需进行属性映射。

3.2.5 研发设备控制面板

第三方云根据设备型号配置,研发设备控制面板。

3.2.6 设备控制面板发布

第三方云发布设备控制面板。

3.2.7 设备调试

平台及APP研发完成后即可进行调试,调试通过后即可完成云对接。