快速入门

快速入门

概述

本文档介绍了涂鸦云端提供api接口(openApi),应用端(PC)利用工具(postman)发送HTTPS请求实现创建用户、获取用户设备、获取设备数据、远程控制设备等功能。

开发者在开始编码之前可以通过使用postman这个HTTPS请求工具调用openApi接口,快速了解涂鸦云API对外输出的能力,以了解是否符合契合自己的云对接需求。

环境准备

这一步,假定您已经在涂鸦开发者平台注册了开发者帐号并已经申请开通了云API授权;

工欲善其事,必先利其器,在开始之前,我们先准备好postman及涂鸦云相关的环境,具体操作如下:

Postman 接口导入

Postman 环境导入

  • 添加必要数据: 点开环境,选择新导入的tuya环境,输入clientId(accessId),secret(accessKey),deviceId(设备id),schema即可:

Postman 必要数据填写

至此,postman环境已经准备好了,可以开展后续。如果您还对postman这款工具还有疑问,可在网上找相应攻略,postman对程序员而言是一款快速了解api的利器。

利用openApi控制设备

体验控制设备之前,您需要在涂鸦开发者平台创建一款产品,并在这款产品下创建一个虚拟设备,接下来,您就可以通过API来控制该设备。

准备工作

  • 创建产品

  • 选择app界面

  • 扫描「请用“涂鸦智能APP”扫码体验手机控制」下方出现的二维码

  • 在涂鸦智能app中进入扫描到设备详情页并获取设备虚拟id

简单模式获取access_token

选择云云对接API文件夹中"简单模式获取access_token"接口,点击send,如下图所示,请求成功:

Postman 获取accessToken 如果其他接口提示token过期,请重新点击此接口获取token。

查询设备支持的指令集

选择接口"查询设备支持的指令集":

Postman 指令集

控制设备

选择接口"设备指令下发",点击"Body",选择类型"raw"-“JSON(application/json)”,填入json格式的内容即可:

Postman 下发指令

查询设备当前状态

选择接口"获取设备功能点的信息":

Postman 设备功能状态

利用openApi拉取数据

涂鸦云支持提供了丰富的API供开发者获取属于自己的用户、设备数据。需要注意的是,用户使用涂鸦官方应用:涂鸦智能和智能生活,通过这两款app产生的用户数据归属权是涂鸦智能, 所以,涂鸦官方应用的用户数据,开发者无权限获取。

关于设备数据,涂鸦提供了两种维度供开发者拉取:应用维度、产品维度。

  • 应用维度:设备绑定的用户属于开发者在涂鸦云应用中的用户,开发者间接拥有权限操作属于自己应用用户的设备;
  • 产品维度:设备所属产品属于开发者在涂鸦云产品中的设备,开发者对这类设备具有操作权限。

注:当调用设备相关接口出现"permission deny"时,您可对照上述两个权限维度检查一下是否符合。

创建用户

选择接口"云端用户注册",点击"Body",选择类型"raw"-“JSON(application/json)”,填入json格式的内容即可:

  • 注:password推荐使用md5进行加密

Postman 创建用户

获取用户设备数据

选择接口"根据用户获取设备信息": Postman 根据用户获取设备信息

获取用户数据

选择接口"获取用户列表":

Postman 获取用户列表

结束语

通过上述简单教程,相信您大致了解了涂鸦云openApi提供的能力,接下来可以编码实现涂鸦云api并进行相应业务开发;

更多接口,可参考API接口列表,如果还有更多定制需求,请联系涂鸦商务。

如果针对接口调用还有疑问,可在涂鸦开发者平台提单询问技术问题,询问问题前,尽量提供出接口请求参数。

400-881-8611