智栖云 QiCloud
  1. Device
智栖云 QiCloud
  • deviceService
    • Device
      • 绑定设备
        POST
      • 设备配网
        POST
      • 解绑设备
        POST
    • DeviceInfo
      • 删除设备信息
      • 获取设备信息
      • 获取设备列表
      • 更新设备信息
  • userService
    • Auth
      • 申请邮箱验证码
      • 使用邮箱登录
      • 使用用户名登录
      • OAuth 登录
      • OAuth 回调
      • 用户注册
      • 重置密码
    • Email
      • 验证邮箱验证码
    • User
      • 获取用户信息
      • 更新用户信息
    • Security
      • 绑定 OAuth
      • 修改邮箱
      • 修改密码
      • 解绑 OAuth
    • Family
      • 删除家庭组
      • 获取家庭组信息
      • 创建家庭组
      • 修改家庭组信息
      • 移除家庭组成员
      • 获取家庭组成员列表
      • 添加家庭组成员
      • 修改家庭组成员权限
  1. Device

设备配网

POST
/device/provision
Device
为设备提供 MQTT 接入信息

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Body 参数application/json
配网请求参数
device_id
string 
设备ID
必需
示例值:
device123
示例
{
    "device_id": "device123"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://device.qicloud.tech/api/v1/device/provision' \
--header 'Content-Type: application/json' \
--data-raw '{
    "device_id": "device123"
}'

返回响应

🟢200成功
application/json
成功配网
Body
配网响应
code
integer 
状态码
可选
示例值:
200
message
string 
消息
可选
示例值:
配网成功
mqtt_host
string 
MQTT 主机
可选
示例值:
localhost
mqtt_password
string 
MQTT 密码
可选
示例值:
mqttpass
mqtt_port
integer 
MQTT 端口
可选
示例值:
1883
mqtt_topic
string 
MQTT 主题
可选
示例值:
devices/device123/status
mqtt_username
string 
MQTT 用户名
可选
示例值:
mqttuser
示例
{
    "code": 200,
    "message": "配网成功",
    "mqtt_host": "localhost",
    "mqtt_password": "mqttpass",
    "mqtt_port": 1883,
    "mqtt_topic": "devices/device123/status",
    "mqtt_username": "mqttuser"
}
🟠400请求有误
🔴500服务器错误
上一页
绑定设备
下一页
解绑设备
Built with