简体中文
简体中文
English
联系我们
注册
登录

注册设备

更新时间:2022-05-05 10:00:16

本文介绍注册设备的 API。

接口描述

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

接口地址

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

请求参数

参数名类型参数位置是否必填说明
third_cloud_device_idStringuritrue合作⼚商设备唯⼀ ID,建议采⽤设备端可读取的唯⼀标识,例如设备的 SN 号、MAC 地址 、IMEI 号等,⻓度不超过 32 个字符

body 说明

参数名类型参数位置是否必填说明
device_nameStringbodytrue设备名称,⻓度不超过 50 个字符
product_idStringbodytrue涂鸦产品 ID
optionsObjectbodyfalse设备扩展信息,包含:
  • installLocation:安装地址
  • outProjectId:设备在合作⼚商云的项⽬ ID
  • mac:MAC 地址
  • extendData:JSON,如:{"roomNo":"16"}, 其中 roomNo 为酒店房间号

返回参数

参数名类型说明
resultObject响应结果
codeBoolean参见错误码,成功为空
msgString请求失败的信息,成功为空
successBoolean请求是否成功。
  • true:成功
  • false:失败
tLong请求响应的时间戳,长度 13 位

result 说明

参数名类型说明
device_idString涂鸦设备 ID

请求示例

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
}

错误码

参考 错误码