文档中心

1. 概述

本文档为您介绍如何通过API操作设备管理的部分功能，阅读本文当前请您先熟悉相关核心概念，并确认您已在度家AIOT语音平台的控制台上完成创建厂商、创建产品两个步骤,操作详情请参考快速入门。

2. 接口概览

目前度家AIOT语音平台提供下列设备管理接口，注意下方表格中的"ak"、"sk"是设备管理API中与fc、pk对应的参数，而不是百度云鉴权的Access Key（AK）和Secret Access Key（SK）。

3.通用说明

API调用遵循HTTPS协议，目前只支持BJ Region，具体域名为smarthome.baidubce.com。 数据交换格式为JSON，所有request/response body内容均采用UTF-8编码。

3.1 实名认证

使用SHC API的用户需要实名认证，没有通过实名认证的可以前往百度智能云官网控制台中的安全认证下的实名认证中进行认证。 百度云提供个人认证、企业认证两种认证方式，您可以根据实际情况选择一种进行认证。

3.2 API认证机制

所有API的安全认证一律采用Access Key与请求签名机制。 Access Key由Access Key ID和Secret Access Key组成，均为字符串。 对于每个HTTP请求，使用下面所描述的算法生成一个认证字符串。提交认证字符串放在Authorization头域里。服务端根据生成算法验证认证字符串的正确性。 认证字符串的格式为bce-auth-v{version}/{accessKeyId}/{timestamp}/{expirationPeriodInSeconds}/{signedHeaders}/{signature}。

• version是正整数。
• timestamp是生成签名时的UTC时间。
• expirationPeriodInSeconds表示签名有效期限。
• signedHeaders是签名算法中涉及到的头域列表。头域名之间用分号（;）分隔，如host;x-bce-date。列表按照字典序排列。（本API签名仅使用host和x-bce-date两个header）
• signature是256位签名的十六进制表示，由64个小写字母组成。

当百度云接收到用户的请求后，系统将使用相同的SK和同样的认证机制生成认证字符串，并与用户请求中包含的认证字符串进行比对。如果认证字符串相同，系统认为用户拥有指定的操作权限，并执行相关操作；如果认证字符串不同，系统将忽略该操作并返回错误码。

鉴权认证机制的详细内容请参见鉴权认证机制。

3.3 通信协议

仅支持HTTPS调用方式。

3.4 请求结构说明

数据交换格式为JSON，所有request/response body内容均采用UTF-8编码。

请求参数包括如下4种：

3.5 响应结构说明

响应值分为两种形式：

3.6 API版本号

3.7 日期与时间规范

日期与时间的表示有多种方式。为统一起见，除非是约定俗成或者有相应规范的，凡需要日期时间表示的地方一律采用北京时间，遵循ISO 8601，并做以下约束：

• 表示日期一律采用YYYY-MM-DD方式，例如2014-06-01表示2014年6月1日。
• 表示时间一律采用hh:mm:ss方式，例如23:00:10表示北京时间23点0分10秒。
• 凡涉及日期和时间合并表示时，在两者中间加空格，例如2014-06-01 23:00:10表示北京时间2014年6月1日23点0分10秒。

3.8 规范化字符串

通常一个字符串中可以包含任何Unicode字符。在编程中这种灵活性会带来不少困扰。因此引入“规范字符串”的概念。一个规范字符串只包含百分号编码字符以及URI（Uniform Resource Identifier）非保留字符（Unreserved Characters）。 RFC 3986规定URI非保留字符包括以下字符：字母（A-Z，a-z）、数字（0-9）、连字号（-）、点号（.）、下划线（_）、波浪线（~）。

将任意一个字符串转换为规范字符串的方式是:

• 将字符串转换成UTF-8编码的字节流。
• 保留所有URI非保留字符原样不变。
• 对其余字节做一次RFC 3986中规定的百分号编码（Percent-Encoding），即一个%后面跟着两个表示该字节值的十六进制字母。字母一律采用大写形式。

示例： 原字符串：this is an example for 测试, 对应的规范字符串：this%20is%20an%20example%20for%20%E6%B5%8B%E8%AF%95。

3.9 度家AIOT语音平台产品编码要求

• 可解析内容，所有request/response body内容目前均使用UTF-8编码，后续会支持更多encoding类型。

• 在请求时，需要对以下做UrlEncode：

  • Objectname，其中，Resource做UrlEncode的时候需要忽略“/”。
  • Querystring的Value。
  • x-bce-copy-source（忽略“/”）。
  • 自定义Meta:Meta Value只支持可见的ASCII字符，如果需要其它的字符，推荐使用UrlEncode处理。

3.10 度家AIOT语音平台服务域名

3.11 公共请求头与公共响应头

公共请求头

公共响应头

3.12 错误码

错误码格式

当用户访问API出现错误时，会返回给用户相应的错误码和错误信息，便于定位问题，并做出适当的处理。请求发生错误时通过Response Body返回详细错误信息，遵循如下格式：

例如：

{ 
    "code":"IllegalRequestUrl", 
    "message":"The requested url belongs to domain which is not under acceleration",
    "requestId":" 81d0b05f-5ad4-1f22-8068-d5c9de60a1d7" 
}

公共错误码

度家AIOT语音平台自定义错误码说明

4.设备管理API

4.1 批量（单个）导入设备

基本信息

Path： /v1/manage/device

Method： POST

请求参数

Body

返回数据

返回示例

{
    "code":0,
    "message":""
}

4.2 删除设备(单个)

基本信息

Path： /v1/manage/device/:fc/:pk/:ak

Method： DELETE

路径参数

返回数据

返回示例

{
    "result":"OK"
}

4.3 禁用设备(单个)

基本信息

Path： /v1/manage/device/:fc/:pk/:ak/disable

Method： PUT

路径参数

返回数据

返回示例

{
    "result": "OK"
}

4.4 启用设备(单个)

基本信息

Path： /v1/manage/device/:fc/:pk/:ak/enable

Method： PUT

路径参数

返回数据

返回示例

{
    "result": "OK"
}

4.5 获取设备信息(单个)

基本信息

Path： /v1/manage/device/:fc/:pk/:ak

Method： GET

路径参数

返回数据

返回示例

{
    "accountUuid":"611f366b29f64d04ad2ed130d32835d2",
    "fc":"8gt3x2",
    "pk":"n806btcp",
    "ak":"6bdca967-ff15-4c1c-8a1c-841269b43d27",
    "sk":"mock",
    "state":"ACTIVATED",
    "createTime":"2020-03-23 06:39:53",
    "updateTime":"2020-03-23 06:39:53"
}

4.6 获取设备信息(列表)

基本信息

Path： /v1/manage/device

Method： GET

请求参数

返回数据

返回示例

{
    "totalCount":1,
    "result":[
        {
            "accountUuid":"611f366b29f64d04ad2ed130d32835d2",
            "fc":"8gt3x2",
            "pk":"n806btcp",
            "ak":"6bdca967-ff15-4c1c-8a1c-841269b43d27",
            "sk":"mock",
            "state":"ACTIVATED",
            "createTime":"2020-03-23 06:39:53",
            "updateTime":"2020-03-23 06:39:53"
        }
    ],
    "pageNo":1,
    "pageSize":10,
    "fc":"8gt3x2",
    "fcName":"hjt",
    "pk":"n806btcp",
    "devSku":"HB－QBT－1",
    "orderBy":"createTime",
    "order":"desc",
    "state":"NOT_ACTIVE"
}

4.7 获取Toekn

基本信息

Path： /v1/manage/device/token

Method： POST

请求参数

返回数据

返回示例

{
    "token":"xxx.xxx.xxx"
}