文档中心

快速入门

更新时间:2020-09-26 03:05:21下载pdf

本篇旨在帮助开发者快速了解涂鸦云开放平台的使用流程,即刻开启万物互联的智能世界。

云开发平台是涂鸦推出的一套面向涂鸦开发者的技术服务。通过开放云端 OpenAPI 和设备端 SDK,云开发平台向开发者围绕硬件设备提供更好的附加服务,甚至开发出具有自身特色的 IoT 平台。同时,SaaS 开发者也可以利用涂鸦丰富的 IoT 硬件生态开发出有竞争力的行业 SaaS。

前提条件

操作流程

仅需五步,即可玩转涂鸦云开放平台,使用流程如下。

快速入门

创建项目

  1. 登录IoT 工作台

  2. 单击顶部导航栏中的云开发

  3. 云开发页面,点击立即创建
    快速入门

  4. 创建项目页面,配置项目名称、项目描述和服务行业信息。

  5. 单击创建,完成项目创建。

说明:完成项目创建后,您可以在项目概要 > 授权密钥信息。密钥是请求 OpenAPI 的授权凭证,请妥善保管。

扫码授权

您可以通过涂鸦智能App,扫描二维码将设备关联至您的项目。

  1. 云开发 > 设备管理 > 关联设备页面,单击关联 App 帐号下的设备快速入门
  2. 关联 App 帐号下的设备页面,单击添加 App 账号
  3. 通过涂鸦智能 App 或 OEM App 扫码获取授权。
    快速入门

解锁开发能力

您可以在涂鸦 IoT 工作台的云开放平台完成 OpenAPI 权限的申请以及消息订阅的开通。

  • 申请API权限
    您可以在API 分组中,申请需要开通的 API 分组权限。
    快速入门

    说明:目前涂鸦云开放平台的全部 API 分组均默认开放,后续高阶 API 分组将需要您单独申请开通。

  • 开通消息订阅
    您可以在消息订阅模块中,点击开通消息订阅服务,并配置消息订阅参数。

    • 开启消息订阅
      快速入门

    • 配置消息订阅参数
      快速入门

模拟调用

通过涂鸦云平台创建的 App 已经内置涂鸦 SDK,可实现与涂鸦云平台交互,控制设备。本文以使用 Postman 为例,为您介绍如何通过调用 OpenAPI, 模拟控制设备。

环境准备

  • Postman 简介

    Postman 是一款功能强大的网页调试与发送网页 HTTP 请求的 Chrome 插件。

  • 设置 Postman 环境
    Postman 及涂鸦云相关的环境配置步骤如下。

    1. 点击 下载 Postman

      说明:建议下载 7.12.0 及以上版本。

    2. 导入涂鸦云 API 接口包
      快速入门

    3. 导入涂鸦云 API 环境包
      快速入门

    4. 设置环境变量。
      快速入门

    参数名 说明
    url 涂鸦云服务,例如中国区为 https://openapi.tuyacn.com
    client_id 用户名,等同于开发者平台中的 accessId
    secret 密码,等同于开发者平台中的 accessKey
    device_id 设备 ID,可在 App 内查看设备对应的信息。
    schema App 应用的渠道标识符。请根据 App 程序包名称进行设置。例如,您的 App 程序包名为 com.aa.bb,那么您的 schema 值为 aabb

    说明:App 内点击您添加的设备,单击右上角有个铅笔图标后,可以在 设备信息查看设备 ID。

  • OpenAPI 设置

    • 请求方式
      OpenAPI 支持以下四种请求方式。

      • GET
      • PUT
      • POST
      • DELETE

      注意:当请求方式为 POST 时,Content-Type 需使用 application/json

    • 请求头设置
      任意接口都需要在请求头 header 中加入以下参数。

    参数名 类型 参数位置 说明 必填
    client_id String header client_id
    sign String header 采用指定签名算法计算出的签名:token 相关接口、业务相关接口
    sign_method String header 签名的摘要算法,HMAC-SHA256
    t Long header 13 位标准时间戳
    lang String header 语言,默认为 en
    • 签名方式:涂鸦云根据不同应用场景,当前提供两套签名算法。

      • token 相关接口:(v1.0/token&v1.0/token/{refresh_token}):sign = HMAC-SHA256(client_id + t, secret).toUpperCase()

      • 业务接口(非 token 接口):sign = HMAC-SHA256(client_id + access_token + t, secret).toUpperCase()

Postman 控制设备实战

以 Wi-Fi 插座为例为您介绍如何使用 Postman 控制设备。详细操作步骤参见配网实践

  1. 获取 token
    通过 AccessID 获得 token,后续利用此 token 请求其他 API,否则有权限问题。
    快速入门

    说明grant_type=1 表示是使用简单模式授权。

  2. 查询设备支持的指令集
    获取设备支持的指令,后续控制设备可以根据此结果。
    快速入门

  3. 控制设备
    根据设备支持的指令,可以针对下发控制设备,实现不同的效果。
    快速入门

    说明:其他接口的使用方法参考开发者文档。

数据统计

您可以在涂鸦 IoT 工作台 > 云开发中查看您的数据统计。涂鸦提供两种数据维度的统计展示。

  • API请求统计
    快速入门
  • 消息订阅统计
    快速入门

FAQ

Q: token 有效期是多长时间?

Tuya: token 有效期为两个小时,过期后需重新申请。

Q: clientId 和 secret 是什么,怎么获取?

Tuya: clientId 为开发者平台中的 AccessId, secret 为开发者平台中的 AccessKey。

Q: schema 是什么,怎么获取?

Tuya: App 应用的渠道标识符,请根据 App 包名获取。例如,您的 App 包名为 com.aa.bb,那么您的 schema 值为 aabb

Q: 应用场景下,数据操作权限是怎样的?

Tuya: 应用场景下, App内的设备,开发者具有操作权限。

Q: 访问接口遇到 permission deny,是什么原因?

Tuya:

  1. 检查设备是否已经被移除。
  2. 设备是否与当前开发者clientId有关联。

结束语

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

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

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

点击获取服务和帮助