OneNET Studio提供项目、设备、服务等云端API,帮助快速开发应用,满足场景业务需求。
API接口请求参数包括公共参数和自定义业务参数两部分。公共请求参数是调用每个API时都需要携带的请求参数, 包括服务命名空间、接口名称、版本信息。自定义业务参数由各接口定义,根据调用方法不同,需要将参数携带至请求路径或者请求体中。API接口公共参数调用如下所示:
https(http)://openapi.heclouds.com/{namespace}?action=xxxx&version=1
| 序号 | 参数 | 类型 | 是否必选 | 描述 |
|---|---|---|---|---|
| 1 | namespace | string | 是 | API接口类别, 包括: 应用开发类-application 设备管理类-common LwM2M IPSO开发类-lwm2m-online、lwm2m-offline |
| 2 | action | string | 是 | API接口名称 |
| 3 | version | string | 是 | API版本号, 目前所有API接口版本均为1 |
成功响应:
{
"requestId": "8906582E6722409AA6C40E7863B733A5",
"success": true,
"data": {
status: 1
}
}
失败响应:
{
"requestId": "8906582E6722409AA6C40E7863B733A5",
"code": "iot.application.deviceNotFound",
"msg": "device does not exist",
"success": false
}
| 序号 | 参数 | 类型 | 描述 |
|---|---|---|---|
| 1 | requestId | string | 请求ID,调用API时由平台生成唯一请求标识 |
| 2 | code | string | 调用失败时,返回的错误码 |
| 3 | msg | string | 调用失败时,返回的错误信息 |
| 4 | success | boolean | 接口是否调用成功 |
| 5 | data | object | 调用成功时,返回的业务数据(接口无业务数据返回,值为null) |