运维开发网

接口列表及接口说明

运维开发网 https://www.qedev.com 2020-11-13 09:32 出处:51CTO 作者:IoT云工坊
接口列表及接口说明授权管理获取访问令牌:开发者通过开发平台创建云应用对应的授权凭证获取令牌。刷新用户令牌:出于安全考虑,当前每个OAuthtoken的有效期为两小时,过期以后需要使用refresh_token来换取新的令牌。说明:access_token有时间限制,无次数限制;而refresh_token无时间限制,但是只能生效一次。免登录令牌:根据涂鸦用户uid生成免登录令牌,部分场景或者API

接口列表及接口说明

授权管理

获取访问令牌:开发者通过开发平台创建云应用对应的授权凭证获取令牌。

刷新用户令牌:出于安全考虑,当前每个 OAuth token 的有效期为两小时,过期以后需要使用 refresh_token 来换取新的令牌。

说明:access_token 有时间限制,无次数限制;而 refresh_token 无时间限制,但是只能生效一次。

免登录令牌:根据涂鸦用户uid生成免登录令牌,部分场景或者API接口需要使用此令牌进行请求。

用户管理

同步用户:该接口为账号同步接口,您可结合自己的业务场景,根据不同参数来完成账号创建和账号信息修改。

在同一应用下,传入相同用户名,则会更新该用户上一次的用户信息。

如需在涂鸦 OEM App 中直接使用,OEM App 当前仅支持手机号和邮箱地址,且密码 hash 规则为 MD5 算法。

获取用户列表:您在涂鸦 IoT 平台创建的应用关联到的用户数据,可通过该 API 完成拉取。考虑到用户隐私安全,针对用户个人隐私字段,将进行加密处理。

获取用户信息:用来获取用户信息。

配网管理:随着产品配网方式丰富度的提高,云开发平台对主流配网能力进行了迭代,提供了权限管理接口来满足不同配网方式的诉求,例如 Wi-Fi 配网、蓝牙配网、蓝牙 + Wi-Fi 双模配网等方式。

生成配网令牌:发现设备之前,需要先申请一个临时令牌,经过涂鸦客户端 SDK 进行配网,设备接到配网令牌后可自动完成发现和账号绑定。当前支持 Wi-Fi 配网和 BLE + Wi-Fi 配网方式,更多能力持续拓展中(BLE 设备需扫描设备二维码获取设备唯一 ID 用于配网)。

轮询配网结果:由于设备配网是一个异步流程,根据网络质量的不同,设备成功入网的时间不定,故需要开发者轮询该接口直至查询到设备列表或到超时停止轮询(轮询周期为 1 秒一次,超时时间建议为 100 秒)。

开放网关允许子设备入网:由于子设备不具备直接的联网能力,故而添加子设备需要网关加入。网关进入允许入网状态后,子设备可以加入网关的本地网络,通过网关完成入库。

获取入网子设备列表:子设备配网是一个异步流程,配网时会根据设备数量以及网络情况陆续将子设备加入网关。因此需要根据初次发现时间轮询此接口获取子设备列表,可结合自身业务结束发现流程,建议每次轮询 1 秒直至 100 秒结束。

获取网关下的子设备列表:通过网关设备 ID,获取子设备列表。

设备控制

获取指令集(按品类):按品类来查询指令集,该指令集为涂鸦公版品类下最丰富的指令集,可供开发者参考使用。如果是平台类开发者,建议可按照此类进行开发对接。

获取指令集(按设备):查询设备支持的功能,获取到的指令可用于下发控制。

获取设备规格属性(包含指令集、状态集):根据设备 ID 获取设备支持的指令集和状态集。

下发设备指令:根据获取到的指令集,可按一组或多组指令集进行下发,是否同时支持多指令同时执行依具体产品而定。

获取设备最新状态:根据设备 ID 来查询设备最新状态。

定时管理

设备添加定时任务:该接口为设备添加定时任务。通过参数 loops,可分为循环定时任务与非循环定时任务。

循环定时:以一周为循环,可设定周一到周日的循环定时。

非循环定时:设定指定时间节点的定时任务,接口会对设定的时间节点做限定。该时间节点需要在当前时间之后,否则无法创建定时任务,并提示定时任务已过期。

查询设备下的定时任务列表:该接口用于查询指定设备 ID 下已添加定时任务的详细信息列表。

获取设备某一个分类下⾯的定时任务信息:该接口用于获取指定设备下某⼀个分类下⾯的定时任务信息。

更新设备的某⼀个定时任务组的信息:该接口用于更新设备的某一个定时任务组的信息。

更新/获取设备定时任务组的状态:该接口用于更新/获取设备定时任务组的状态。

创建/更新群组定时任务:该接口用于创建/更新群组定时任务。

​​​​​​​全屋管理

添加家庭:给⽤户添加⼀个家庭以及家庭下的房间。

修改家庭:修改家庭基础信息。

删除/查询家庭:根据家庭ID删除/查询家庭。

查询家庭下的设备详情:根据家庭 ID查询家庭下的设备列表。

添加房间:根据家庭ID添加房间

修改/删除/查询房间:根据家庭 ID 和房间 ID 修改/删除/查询房间。

添加家庭成员:给某个家庭添加家庭成员。

设置成员权限:为家庭成员设置管理员和非管理员的角色权限,修改家庭成员的名字。

删除/查询家庭成员:删除/查询某个家庭下成员。

查询⽤户所在的家庭列表:根据 uid 查询⽤户所在的家庭列表。

查询/新增/修改/删除家庭下房间内的设备:查询/新增/修改/删除家庭下房间内的设备。

场景自动化

查询家庭下的场景列表:查询家庭下的场景列表。

查询默认场景图片列表:查询默认场景图⽚列表。

触发/添加/删除/修改场景:触发执/添加/删除/修改行某个场景。

查询家庭下支持场景的设备列表:查询家庭下支持场景的设备列表。

场景绑定/绑定:接口主要适用于场景开关设备。场景开关有相应的开关按钮,每个开关按钮拥有相应的指令。通过该接口,可以将指定的开关指令与场景进行绑定,即场景开关与场景进行关联操作。绑定成功后,通过指令下发接口,可以直接触发场景。

场景解绑:接口主要适用于场景开关设备。场景开关中的某个开关与指定场景绑定后,可通过该接口进行解绑。

查询设备已绑定的场景列表:接口主要适用于场景开关设备。通过场景开关设备 ID,查询该设备所关联的场景列表。

添加/修改/删除自动化:为家庭添加/修改/删除自动化功能。

查询自动化列表:查询自动化列表。

查询单个自动化:查询家庭中单个自动化场景。

触发自动化外部条件:触发家庭中自动化场景的外部条件。

查询支持自动化场景的设备列表:查询家庭下支持自动化场景的设备列表。

查询自动化场景支持的天气条件:查询自动化支持的天气条件。

获取家庭支持的联动条件:根据家庭 ID 获取联动条件或执行动作的标准功能点。

获取设备支持的联动条件:根据设备 ID 获取联动条件或执行动作的标准功能点。

启用/停用自动化:启用/停用自动化场景。

数据服务

获取数据总体概况:获取数据总体概况。

统计 App 日注册用户数:统计 App 日注册用户数。

统计 App 日活跃用户数:统计 App 日活跃用户数。

获取 App 设备数据概况:获取 App 设备数据概况。

获取设备总体概况:获取设备总体概况。

获取活跃设备地区分布数据:获取活跃设备地区分布数据。

获取激活设备地区分布详情数据:获取激活设备地区分布详情数据。

统计设备日活跃数/激活数/共激活数据:统计设备日活跃数/激活数/共激活数据。

获取设备活跃数据概况:获取设备活跃数据概况。

获取历史累计值:获取历史累计值。

获取设备支持的统计类型:查询设备当前支持的统计类型。

按小时/天/星期/月统计:以小时/天/周/月为单位,返回设备近 7 天的统计数据。

天气服务

查询城市列表:根据国家码获取该国支持天气数据城市的信息。

查询城市信息:根据城市ID来查询城市信息。

根据经纬度查询城市列表:根据经纬度查询城市列表。

查询城市天气预报:根据城市 ID查询天气预报。

根据IP查询天气预报:根据城市 IP 查询天气预报。

根据经纬度查询天气:根据城市经纬度来查询城市的天气信息。

查询城市当前天气情况:根据城市ID查询城市当天天气情况。

设备管理

获取设备详情:可查询设备的详情信息,包括设备属性和设备最新状态。

获取用户下设备列表:可查询用户下可操作的设备列表,包括设备属性、设备最新状态。

获取设备列表:提供按应用、产品、设备 ID 查询设备列表的能力,调用该接口时,建议请求参数三选一。数据权限维度满足以下任意一种,则可获取相关设备数据:

应用维度:应用维度针对于设备采购商。设备采购商通过将应用(在涂鸦平台创建的 OEM App 或者基于涂鸦的客户端 SDK 自行开发)绑定设备的方式来获取设备的数据。

产品维度:产品维度针对于设备生产厂商。生产厂商通过在涂鸦平台创建产品,然后基于这个产品来生产设备(设备连接涂鸦云),最终获取或管控厂商所生产设备的数据。

修改功能点名称:满足多路子设备,可以进行子设备名称修改。

查询设备日志:根据查询条件查询设备操作历史记录。

恢复设备出厂设置:根据设备 ID 来恢复出厂设置。

移除设备:根据设备 ID 来移除设备。

查询网关下的设备列表:查询网关下的设备列表。

查询设备出厂信息:查询设备出厂信息。

修改设备名称:修改设备名称。

修改多路名称:当设备存在多路名称时可修改,现支持排插类设备。

OTA升级

获取设备的升级信息:获取设备的升级信息。

确认设备升级:确认设备升级。

设备群组

查询设备群组列表

查询群组详情

查询群组列表

创建设备群组

修改群组分组

删除群组分组

给设备群组下发指令

扫码领视频副本.gif

0

精彩评论

暂无评论...
验证码 换一张
取 消

关注公众号