API 调用说明
API是Aqara开发者平台对外提供数据的接口，用于查询、控制设备和配置自动化、场景等信息。目前开放的API接口默认为已授权状态。
请求格式
请求URL格式：https://${domain}/v3.0/open/api。
${domian}为服务地区的域名，详情见域名地址，私有化服务则为具体的ip地址。
示例：
域名地址
绿米云平台在中国大陆、美国、欧洲、韩国、俄罗斯、新加坡均部署了服务器，用户可根据所在位置选择服务器。
| 服务器 | APP SDK 服务器域名 | 设备接入服务器域名 | 开放平台API接口服务器域名 | 时区 |
|---|---|---|---|---|
| 中国大陆 | aiot-rpc.ankasa.cn | aiot-coap.aqara.cn | open-cn.aqara.com | +8 |
| 美国 | aiot-rpc-usa.aqara.com | aiot-coap-usa.aqara.com | open-usa.aqara.com | +12 |
| 韩国 | rpc-kr.aqara.com | coap-kr.aqara.com | open-kr.aqara.com | +9 |
| 俄罗斯 | rpc-ru.aqara.com | coap-ru.aqara.com | open-ru.aqara.com | +5 |
| 欧洲 | rpc-ger.aqara.com | coap-ger.aqara.com | open-ger.aqara.com | +1 |
| 新加坡 | rpc-au.aqara.com | coap-sg.aqara.com | open-sg.aqara.com | +8 |
请求参数
请求header参数
注意：请求header中务必携带以下必填项参数。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Accesstoken | String | 否 | 通过授权获取的访问Token |
| Appid | String | 是 | 第三方应用的Appid |
| Keyid | String | 是 | appKey对应id |
| Nonce | String | 是 | 随机字符串，每次请求都不同 |
| Time | String | 是 | 请求时间戳，单位毫秒 |
| Sign | String | 是 | 请求签名 |
| Lang | Enum | 否 | 语言，默认英文，'zh', 'en' |
固定请求参数
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| intent | String | 是 | 请求意图 |
| data | Object | 是 | 请求数据，详见各接口说明 |
固定响应参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| code | int | 是 | 返回错误码，0：成功，其他错误码请参考错误码说明 |
| requestId | String | 是 | 请求id |
| message | String | 是 | 返回码描述 |
| result | Object | 否 | 接口返回数据，详见各接口说明 |
API列表
已开放接口的详细说明请参考API列表。