文档

测试

设备注册(创建设备)

websocket测试

POST

/devices

接口描述

注册一个设备

请求参数

application/json

参数名

类型

描述

必填

参数要求

jsonrpc

str

JSON-RPC协议版本，必须写为“2.0”

必填

2.0

method

str

方法名称，指定为"device-add"

必填

device-add

params

dict

参数字典，包含设备注册需要的信息

必填

字典类型

device

Device_dict

Device结构的字典

必填

sn

str

设备序列号，设备本身也需要一个sn

必填

name

str

设备名

必填

全设备唯一

desc

str

简短的设备描述

可选

hardware

list

硬件列表，包含设备的所有硬件信息

必填

每一个列表元素都是下面定义的结构

Hardware

hardware_dict

硬件字典，包含设备的硬件信息

必填

sn

str

硬件唯一系列号sn

必填

type

str

硬件类型，比如以太网、LTE、WIFI

必填

"LTE", "WIFI", "ETH"三选一

mac

str

硬件物理地址mac

必填

imei

str

如果是LTE则需要填写IMEI，默认为空

可选

model

str

设备型号

必填

software

dict

软件字典，包含设备的软件信息

必填

base

dict

基础程序字典，包含设备基础服务程序的信息

必填

version

str

程序版本

必填

vX.Y.Z

last_update_time

int

上次更新的时间戳

必填

时间戳

status

str

程序状态

必填

可用的状态字段

app

dict

业务程序字典，包含业务程序信息

必填

version

str

程序版本

必填

vX.Y.Z

last_update_time

int

上次更新的时间戳

必填

时间戳

status

str

程序状态

必填

可用的状态字段

secret_hash

str

密码散列值hash(password)

必填

hash函数生成的值

id

str

一串随机值，响应时附带

必填

响应参数

application/json

参数名

类型

描述

必填

参数要求

jsonrpc

str

JSON-RPC协议版本，必须写为“2.0”

必填

2.0

result

dict

成功时附带的字典

可选

code

str

状态码

必填

name

str

注册成功的设备名

必填

error

dict

失败时附带的字典

可选

code

str

状态码

必填

name

str

注册失败的设备名

必填

message

str

失败原因描述

必填

id

str

返回的客户端标识id

必填

和请求时的值保持一致

上一篇

nextDoc 删除设备