有关设备 API


设备预配置面向设备提供 API 接口。基于这些接口,设备可以直接完成自注册,并获取自身认证信息。


设备 API 常见的使用场景如下:

  • 设备注册自身并获取响应的 EnOS 三元组认证信息,以便安全地连接到 EnOS。

  • 网关设备获取子设备和支路设备的 EnOS 三元组认证信息,完成 EnOS 连接和数据通信。

API 适用范围


设备 API 适用的设备需要满足以下条件:

  • 能够通过 HTTP/HTTPS 协议发送 POST 请求到指定的地址。

  • 能够获取有效的设备注册信息,用于设备鉴权和自注册。

API 请求格式


设备 API 请求结构分为请求 URI、请求 Header、请求 Body 三部分,其中 请求 Header请求 Body 与应用 API 一致。设备 API 的请求 URI 格式如下:

{URI-scheme}://{dps-address}/{service-name}/{endpoint-URL}

其中:

  • {URI-scheme}:协议,支持 HTTP 和 HTTPS。

  • {dps-address}:设备 API 的专用地址,格式为 iot-dps-{ENV_ID}.envisioniot.com。其中 {ENV_ID} 为环境标识,如 cn5

  • {service-name}:服务的名称,设备 API 的服务名称为 dev

  • {endpoint-URL}:资源及对资源的操作,如 get/conn

API 返回格式


设备 API 的返回为以下格式的 JSON 结构体:

{
    "pk": "ProductKey",
    "dk": "DeviceKey",
    "ds": "DeviceSecret"
}

有关返回参数的详细说明,参见每个 API 文档。

设备 SDK


你可以在 开发者中心 获取设备接入 SDK。