平台提供开放的API接口,用户可以通过 HTTP / HTTPS 调用(推荐使用 HTTPS),进行设备管理,数据查询,设备命令交互等操作,在API的基础上,根据自己的个性化需求搭建上层应用
API地址为:api.heclouds.com
为提高API访问安全性,OneNET API的鉴权参数作为header参数存在
MQTT物联网套件中以accessKey为核心密钥,用户需要使用核心密钥通过签名算法计算签名,与其他参数共同组成token,然后将token作为请求Header参数进行鉴权,见token算法
token 示例如下:
version=2018-10-31&res=products%2F123123&et=1537255523&method=sha1&sign=ZjA1NzZlMmMxYzIOTg3MjBzNjYTI2MjA4Yw%3D
(以“查询设备详情API”为例)
GET /devices/3532392
Authorization: version=2018-10-31&res=products%2F123123&et=1537255523&method=sha1&sign=ZjA1NzZlMmMxYzIOTg3MjBzNjYTI2MjA4Yw%3D
API返回内容中,HTTP状态码进行如下分类:
HTTP状态码 | 状态码说明 |
---|---|
2xx | 执行成功 |
4xx | 客户端的错误,通常情况下客户端需要修改请求然后再次发送请求 |
5xx | 服务端的错误 |
API返回内容如下所示:
{
"request_id": "855b2fe4-3f54-41f2-8cd5-3e34bcfa8356",
"code_no":"000000",
"code":"onenet_common_success",
"message":"success",
"data":{} /* 返回结果数据 */
}
其中,固定参数说明如下:
参数 | 参数说明 |
---|---|
request_id | 平台为每次请求分配的唯一ID |
code_no | 错误码 |
code | 错误码说明 |
message | 错误码详情 |
data | 请求返回数据内容 |
错误码相关说明,请见错误码详情