设备接入 IoTDA设备接入 IoTDA

更新时间:2021/09/06 GMT+08:00
分享

演进说明

概述

为提供更好的API性能、易用性、一致性,我们全新开放了新版本的API。新版的API在请求访问地址、鉴权方式、证书资源、错误响应上都提供了和华为云其它服务一致的体验。针对老版本API进行了优化,并新增了统一的设备和子设备管理能力、基于产品和物模型的管理能力、规则管理能力等。

兼容性说明

应用侧和设备侧新老版本接口兼容性如下表所示:

使用场景

版本分类

应用侧API v3

新版本应用侧API v5

使用设备侧SDK接入

设备侧SDK v3

兼容

兼容

设备侧SDK v5

兼容

兼容

未使用设备侧SDK接入

设备侧API v3

兼容

兼容

设备侧API v5

不兼容

兼容

总体来讲,接口功能上新版接口可以完全兼容老版本,但在部分场景下必须配套使用。

  • 设备侧使用V5的SDK接入,应用侧可以使用V5也可以支持V3接口;
  • 设备侧使用V5的接口接入,应用侧必须全部使用V5接口;
  • 设备侧使用V3的SDK或接口接入,应用侧可以使用V3或V5,以及V3和V5混用,但是存在如下约束:
    • V5部分新功能依赖设备侧接口,新功能则无法使用;
    • V3和V5混用场景下,调用V5接口必须使用V5配套的访问地址、鉴权、授权、证书;调用V3接口必须使用V3配套的访问地址、鉴权、授权、证书;
  • 设备侧接口不支持V3和V5混用。

演进步骤

  • 应用侧API访问地址变更。参考构造请求章节获取所在区域的终端节点信息,将访问应用侧API的域名和端口修改为终端节点域名。例如:北京四区域的设备管理终端节点为“iotda.cn-north-4.myhuaweicloud.com”,注册设备接口的请求url样例为“POST https://iotda.cn-north-4.myhuaweicloud.com/v5/iot/{project_id}/devices”。
  • 鉴权方式变更。参考IAM认证鉴权章节进行认证鉴权,将获取到的X-Subject-Token填写到新版本API的X-Auth-Token参数中。
  • 证书资源变更。应用侧访问新版本API不再需要加载证书和开启SSL校验,具体实现请参考使用Java API Demo调测
  • 接口功能调测。我们为您准备了Java版本的Demo,您可以参考使用Java API Demo调测
分享:

    相关文档

    相关产品