IoT标准请求协议

更新时间:2019-09-18 09:28:16

1、协议

访问API的完整URL:

协议://域名/API路径

协议:根据API定义,支持HTTPS(推荐)和HTTP
域名:访问人居平台域名为api.link.aliyun.com
API路径:在API的定义中,会明确标识API的访问路径。如查询品类列表的path为/home/paas/category/list

image.png
方法:POST

参数:

一级属性 类型 必填 描述
id 字符串 一次请求的标识,该标识由请求发起者生成并且维护
version 字符串 协议版本号
request 对象 由服务提供者确定
params 不限 请求参数,类型包括但不限于对象、数组等。
具体参考API文档中的定义。

2、request 属性

参数 是否必填 参数描述
apiVer API版本
iotToken 登录用户的token(客户端)
cloudToken 云端资源token(云端)
language 国际化扩展,语言。
locale 国际化扩展,地理位置、ip。

3、请求示例

{
    "id": "UniqueRequestId",  // request里的全局唯一id透传
    "version": "1.0",         // 请求协议版本
    "request": {
        "apiVer": "",         // api版本号
        "iotToken": ""        // 登录用户的token
    },
    "params": {
        "iotId": "123",
        "Power": "on"
    }
}

4、响应示例

{
    "id": "UniqueRequestId",      // 必填,request里的全局唯一id透传
    "code" : 200,                 // 必填,结果码
    "message" : "",               // 失败时必填,错误调试信息;成功时不填
    "localizedMsg" : "",          // 失败时必填,用户可理解语言描述的错误信息;成功时不填
    "data" :                      // 成功时必填,失败时选填 
}

results matching ""

    No results matching ""