注册设备

更新时间：2024-02-28 03:28:50下载pdf

本文介绍注册设备的 API。

接口描述

合作厂商设备注册成为涂鸦设备。

POST: /v1.0/iot-03/3rdcloud/devices/{third_cloud_device_id}/register

参数名	类型	参数位置	是否必填	说明
third_cloud_device_id	String	uri	true	合作⼚商设备唯⼀ ID。建议采⽤设备端可读取的唯⼀标识，例如设备的 SN 号、MAC 地址、IMEI 号等，仅包含数字和大小写字母，⻓度不超过 64 个字符。

body 说明

参数名	类型	参数位置	是否必填	说明
device_name	String	body	true	设备名称，⻓度不超过 50 个字符。
product_id	String	body	true	涂鸦产品 ID。
options	Object	body	false	设备扩展信息，包含： `installLocation`：安装地址。 `outProjectId`：设备在合作⼚商云的项⽬ ID。 `mac`：MAC 地址。 `extendData`：JSON，例如 `{"roomNo":"16"}`，其中 `roomNo` 为酒店房间号。
group_id	String	body	false	绑定 ID，可以是家庭 ID 或者资产 ID。如需绑定设备和用户，`group_id` 字段和 `has_qrcode` 字段二选一。
has_qrcode	Boolean	body	false	是否生成设备配网短链。选择该参数，响应结果里就会返回设备配网短链。合作厂商可以根据返回的短链生成二维码，粘贴到设备上。用户拿到设备以后，通过涂鸦的 App 扫描设备上的二维码，进行设备和用户的绑定。如需绑定设备和用户，`group_id` 字段和 `has_qrcode` 字段二选一。

result 说明

参数名	类型	说明
device_id	String	涂鸦设备 ID。
short_url	String	设备配网短链。

POST: /v1.0/iot-03/3rdcloud/devices/A18007210830****/register

{
  "device_name": "测试设备",
  "product_id": "xz0uukkq5oce****",
  "options": {
    "mac": "48ea63fd****",
    "installLocation": "杭州市⻄湖区蒋墩路****"
  }
}

{
    "result": {
        "device_id": "6cf4171005d11e2ca7****"
    },
    "t": 1561456817168,
    "success": true
}