Device API
  1. 设备
Device API
  • 设备
    • 注册设备
      POST
    • 更新设备基础信息
      POST
    • 查询所有基础信息
      GET
    • 查询所有详细信息
      GET
    • 查询单一基础信息
      GET
    • 查询单一详细信息
      GET
    • 删除设备
      POST
  • 分组
    • 创建分组
      POST
    • 更新分组基础信息
      POST
    • 查询所有基础信息
      GET
    • 查询所有详细信息
      GET
    • 查询单一基础信息
      GET
    • 查询单一详细信息
      GET
    • 删除分组
      POST
  • 设备-分组关系
    • 添加“设备-分组”关系
      POST
    • 查询分组所有设备
      GET
    • 查询设备所有分组
      GET
    • 删除单一设备所有所属分组
      POST
    • 删除“设备-分组”关系
      POST
  • 设备管理
    • 远程关机
      POST
  • 设置API页面
    POST
  1. 设备

注册设备

POST
/device/{DeviceID}/register
最后修改时间:2022-05-17 05:49:54
责任人:未设置
根据所提供参数注册一个新设备

请求参数

Authorization
在 header 添加参数
Authentication
示例:
Authentication: ********************
Path 参数
DeviceID
string 
待注册的设备ID
必需
示例值:
{{$randomUUID}}
Query 参数
name
string 
待注册设备的名称
必需
示例值:
TestDevice
series
string 
必需
待注册设备的硬件序列号
示例值:
{{$randomUUID}}
type
string 
必需
待注册设备的硬件类型
示例值:
SimpleDevice
inet
string 
必需
待注册设备的INET MAC地址
示例值:
{{$randomUUID}}
wifi
string 
必需
待注册设备的WIFI MAC地址
示例值:
{{$randomUUID}}
imei
string 
必需
待注册设备的LTE IMEI编码
示例值:
{{$randomUUID}}
secret
string 
必需
待注册设备的SECRET
示例值:
{{$randomUUID}}
device
string 
可选
待注册设备类型,默认为SimpleDevice,如需拓展,需要新建表及相关操作
示例值:
SimpleDevice
description
string 
可选
待注册设备的简介,默认为DefaultDeviceDescription
示例值:
This is a device
bName
string 
可选
待注册设备基础软件版本号,默认为Basic
示例值:
Basic
bStatus
string 
可选
待注册设备基础软件状态,默认为BasicOK
示例值:
BasicOK
eName
string 
可选
待注册设备业务软件版本号,默认为Business
示例值:
Business
eStatus
string 
可选
待注册设备业务软件状态,默认为BusinessOK
示例值:
BusinessOK

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST '/device/{{$randomUUID}}/register?name=TestDevice&series={{$randomUUID}}&type=SimpleDevice&inet={{$randomUUID}}&wifi={{$randomUUID}}&imei={{$randomUUID}}&secret={{$randomUUID}}' \
--header 'Authentication;'

返回响应

🟢200成功
application/json
Body
status
integer 
必需
msg
string 
必需
device
string 
必需
group
string 
必需
示例
{
    "status": 0,
    "msg": "string",
    "device": "string",
    "group": "string"
}
🟠400失败
修改于 2022-05-17 05:49:54
下一页
更新设备基础信息
Built with