简易模式接入

概述

涂鸦云平台为创客和厂商提供了自助式软硬件开发SDK与开放完善的云平台API;

厂商定制的app,产生的用户、设备的数据,归属于厂商,厂商可通过API将用户、设备数据像"刷卡"一样简单随时取走自己的数据。

涂鸦云提供了基于oauth2协议的云云对接方式,开发者可在涂鸦iot平台申请云API,调用涂鸦开放的接口,获取客户自己的用户、设备数据,控制自己有权限的设备等;

厂商可根据涂鸦提供的client_id, secret签名 调用/v1.0/token接口到服务端换取token。

client_id申请流程

  • 注册开发者帐号

云API授权

  • 申请开通云API授权

云API授权

  • 获取accessId & accessKey(等同于client_id & secret)

云API授权

授权流程

Screenshot

  • (A)开发者使用云API clientId 和 secret 进行签名认证;
  • (B)涂鸦云颁发令牌給第三方云。

环境说明

中国区 https://openapi.tuyacn.com
美洲区 https://openapi.tuyaus.com
欧洲区 https://openapi.tuyaeu.com

各接口使用方请根据自身所在区域调用相应接口

请求方式

  • 支持的请求方式如下:

    • GET
    • PUT
    • POST
    • DELETE

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

返回结果

统一返回json,一般格式如下:

业务正常返回:

{
"success": true,
"result": {
//object
}
}

业务错误返回:

{
"success": false,
"code": 100323,
"msg": "token非法"
}

签名方式

涂鸦云根据不同应用场景,当前提供两套签名算法:

  • token获取前签名算法:sign = MD5(client_id + secret + t).toUpperCase()
  • token获取后签名算法:sign = MD5(client_id + access_token + secret + t).toUpperCase()

OAuth2接口说明

签名(sign)

获取token的签名生成规则如下:

sign = MD5(client_id + secret + t).toUpperCase()

采用标准md5算法,生成之后转成大写。

需要注意的是,对于一个请求URL,其有效期是5分钟。

请求头设置

获取token的接口需要在header中加入如下参数:

参数名 类型 参数位置 说明 必填
client_id String header client_id
sign String header 采用token接口签名算法计算出的签名
sign_type String header 签名算法,默认md5,hash
t Long header 13位标准时间戳

业务接口说明

签名(sign)

业务相关接口签名生成规则如下:

sign = MD5(client_id + access_token + secret + t).toUpperCase()

采用标准md5算法,生成之后转成大写。

请求头设置

业务接口都要在header中加上如下参数:

参数名 类型 参数位置 说明 必填
client_id String header client_id
access_token String header 通过上述授权获取的令牌
sign String header 采用业务接口签名算法计算出的签名
t Long header 13位标准时间戳
400-881-8611