文档首页 > > 开发指南> 应用侧开发> 使用API对接> API使用指导

API使用指导

分享
更新时间: 2019/10/18 GMT+08:00

为了降低应用侧的开发难度、提升应用侧开发效率,物联网平台向应用侧开放了丰富的丰富的Restful API(Application Programming Interface)。您可以调用开放的API,快速集成物联网平台的功能,如设备管理、数据采集、命令下发和消息推送等功能。

接口介绍

API分组

应用场景

应用安全接入

本部分接口提供“鉴权”以及“刷新token”两个接口。应用服务器通过调用这两个接口获取鉴权令牌,是调用其他平台API的前提,其他接口调用都需要在请求的Header中携带参数app_keyAuthorization

  • app_key取值与请求参数中appId相同。
  • Authorization的格式为Authorization: Bearer {accessToken}。

关于应用安全接入的接口一般有两种调用模式,一种是每次业务处理前都调用一下鉴权接口重新获取token,然后用token来调用其他业务接口;另外一种是应用服务器有一个有效管理机制,通过定期地刷新token,保证在调用其他业务接口前token都是有效的。

设备管理

本部分接口提供设备管理的相关功能。设备作为一种资源,设备管理接口提供了注册设备,删除设备,修改设备信息、位置信息等。查询设备信息的接口归类在“数据采集”中。

平台的接入的设备有两种,直连设备和非直连设备。

  • 直连设备指已实现TCP/IP协议栈的设备,它可以直接与平台进行通信,常见的设备包括网关、以太网设备、NB-IoT设备等。
  • 非直连设备指未实现TCP/IP协议栈的设备,只能基于一些简单的近场通信协议如ZigBee、ZWave、Bluetooth或者是其他的一些非IP有线方式传输协议如串口、并口等接入,此时需要一个网关设备,先让设备接入到网关,再通过网关与华为物联网平台通信。

设备管理的接口中提供了发现非直连设备、删除非直连设备等接口。如果您的方案中不包含非直连设备,则不需要调用这两个接口。

数据采集

数据采集接口提供设备的查询、批量设备查询、设备历史数据和历史命令的查询、设备能力(即profile中定义的设备能力)查询。

当应用服务器向平台查询设备的历史数据和历史命令时,这些数据已经存储在物联网平台上,因此与设备是否在线无关。

订阅管理

物联网平台允许应用服务器订阅其所关注的事件,每一种事件的每一次订阅都会生成一个subscriptionId,应用服务器可以使用subscriptionId对本次订阅进行查询、更新、删除等操作。

平台是通过Restful接口向应用服务器推送数据的,因此应用服务器需要开发一个Restful接口来接收推送数据,这个接口的URL也需要在订阅时提供给物联网平台。由于不同事件的推送消息结构不同,因此应用服务器可以考虑为每一种事件实现一个Restful接口。

注意事项

  • 关于平台上的事件种类和推送的消息样例,请参考推送通知
  • https推送的前提是先在平台上上传应用服务器的CA证书

命令下发

本部分接口提供命令的创建、删除、查询、批量创建等功能。

批量处理

目前仅支持创建批量下发缓存命令任务,您也可以查询批量任务信息。

设备组管理

应用服务器可以通过本部分接口在物联网平台上管理设备组。设备组是把设备进行分组管理。一个设备可以归属到多个设备组内。

在对设备进行某些操作时(如升级设备软固件、批量下发命令等),可通过设备组来指定要进行操作的设备。

设备升级

若需要对设备进行软固件版本升级,应用服务器可调用本部分接口为多个设备创建升级任务,升级前请确保目标版本包已经上传到物联网平台。当前仅支持对CoAP接入的设备进行软固件版本升级。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区