关于物联网:涂鸦物联网足迹涂鸦云平台接口列表

7次阅读

共计 3561 个字符，预计需要花费 9 分钟才能阅读完成。

前序系列文章__>>>

【涂鸦物联网脚印】涂鸦云平台接口阐明

咱们系列文章，都会围绕如何实现一款智能“隔空接吻机”的开发。心愿能帮到各异地恋__or__异国恋的情侣们！

本文咱们会大略解说 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 查问设施列表的能力，调用该接口时，倡议申请参数三选一。数据权限维度满足以下任意一种，则可获取相干设施数据：
1. 利用维度：利用维度针对于设施采购商。设施采购商通过将利用（在涂鸦平台创立的 OEM App 或者基于涂鸦的客户端 SDK 自行开发）绑定设施的形式来获取设施的数据。
2. 产品维度：产品维度针对于设施生产厂商。生产厂商通过在涂鸦平台创立产品，而后基于这个产品来生产设施（设施连贯涂鸦云），最终获取或管控厂商所生产设施的数据。
批改性能点名称：满足多路子设施，能够进行子设施名称批改。
查问设施日志：依据查问条件查问设施操作历史记录。
复原设施出厂设置：依据设施 ID 来复原出厂设置。
移除设施：依据设施 ID 来移除设施。
查问网关下的设施列表：查问网关下的设施列表。
查问设施出厂信息：查问设施出厂信息。
批改设施名称：批改设施名称。
批改多路名称：当设施存在多路名称时可批改，现反对排插类设施。