页面树结构
转至元数据结尾
转至元数据起始



概览

  • 本文档包括产品管理与设备管理两个模块接口:
    1. 企业开发者可以调用产品系列接口,进行产品的相关管理,包括产品、产品固件版本、产品数据端点、产品数据的转发规则等相关接口。 
    2. 企业开发者可以调用设备系列接口,进行设备的相关管理,目前设备信息包括以下两种: 
  • 基础字段信息:是指XLink默认给设备的信息,指的是id(设备ID)、mac(设备MAC地址)等。 
  • 扩展字段信息:是指由企业自定义扩展的信息,由企业开发者创建,目前默认提供10个扩展字段。

接口详情

1.添加产品

企业管理员添加一个产品,需指定产品名称、类型以及描述。

Request

URL

POST /v2/product


Header

Content-Type:application/json
Access-Token:"调用凭证"


Content

{
"name": "产品名称",
"description": "产品描述",
"link_type": "设备连接类型",
"mode":"产品型号",
"type":"产品类型",
"os_type":"os类型",
"visibility":"可见范围"
 }



字段是否必须描述
name产品名称,32个字符以内
description产品描述,250个字符以内
link_type设备连接类型,见产品附录1
mode产品的型号,64个字符
type产品类型
os_type

os类型

安卓:Android

苹果:Ios

微软:Windows

Linux:Linux

实时系统:Rtos

其他:Other

visibility

可见范围

0:企业可见

1:企业用户均可见

Response

Header

HTTP/1.1 200 OK

Content

{
	    "id": "产品id",
	    "name": "产品名称",
	    "description": "产品描述",
		"mode":"产品的型号",
	    "key": "产品密钥",
	    "link_type": "设备连接类型",
	    "is_release": "是否发布",
	    "is_registerable": "是否允许用户注册设备",
		"is_active_register":"是否允许通过激活注册设备",
		"is_allow_multi_admin":"是否允许设备多个管理员",
		"create_time":"创建时间,"
		"type":"产品类型",
		"quota":"设备配额总数",
		"pics":["http://www.xlink.cn/pic1","http://www.xlink.cn/pic2"],
		"extend":{{keay}:{value}},
		"device_type":"设备类型",
		"categories":["设备品类"],
		"os_type":"os类型",
        "visibility":"可见范围"
	}


字段是否必须描述
id产品ID,32个字符
name产品名称,32个字符以内
description产品描述,250个字符以内
mode产品的型号,长度在64个字符以内
key产品密钥,16个字符
link_type设备连接类型,见产品附录1
is_release是否发布,布尔类型,true或false
is_registerable是否允许用户注册设备
is_active_register是否允许通过激活注册设备
is_allow_multi_admin否允许设备多个管理员,默认为:true
create_time产品创建时间
type产品类型,见产品附录5
quota设备配额总数,整数
pics产品图片列表
extend扩展属性
device_type设备类型
categories产品品类
os_typeos类型
visibility

可见范围

0:企业可见

1:企业用户均可见

2.删除产品

企业管理员根据产品标识product_id url中删除一个已添加的产品,已发布的产品不可删除。

Request

URL

DELETE /v2/product/{product_id}
字段是否必须描述
product_id产品ID,32个字符

Header

Content-Type:application/json
Access-Token:"调用凭证"

Content

Response

Header

HTTP/1.1 200 OK

Content

3.更新产品信息

企业管理员根据产品标识product_id url中修改一个已添加的产品信息,已发布的产品不可修改,<br可修改产品名称、连接类型、描述、是否发布以及是否允许用户注册设备。

Request

URL

PUT /v2/product/{product_id}
字段是否必须描述
product_id产品ID,32个字符

Header

Content-Type:application/json
Access-Token:"调用凭证"

Content

{
    "name": "产品名称",
    "description": "产品描述",
    "link_type": "设备连接类型",
    "mode":"产品的型号",
    "is_release": "是否发布",
    "is_registerable": "是否允许用户注册设备",
    "is_active_register":"是否允许通过激活注册设备",
    "is_allow_multi_admin":"是否允许设备多个管理员",
    "user_role_authority":"普通用户对设备的权限,默认RW",
    "scan_mode":"扫描订阅策略,枚举值,见附录",
    "type":"产品类型",
    "pics":["http://www.xlink.cn/pic1","http://www.xlink.cn/pic2"],
    "qrcode":"产品二维码",

       "categories":["产品品类","产品品类"],

      "is_device_reset_clean_data":false,

      “os_type”:“os类型”,
      "visibility":"可见范围"

}
字段是否必须描述
name产品名称,32个字符以内
description产品描述,250个字符以内
link_type设备连接类型,见产品附录1
mode产品的型号,长度在64个字符以内
is_release是否发布,布尔类型,true或false
is_registerable是否允许用户注册设备
is_active_register是否允许通过激活注册设备
is_allow_multi_admin否允许设备多个管理员
user_role_authority普通用户对设备的权限,默认RW
scan_mode扫描订阅策略,枚举值,见附录
type产品类型,见产品附录5
pics产品图片列表
qrcode产品二维码
categories产品品类
is_device_reset_clean_data设备重置时是否清除数据
os_typeos类型
visibility

可见范围

0:企业可见

1:企业用户均可见

Response

Header

HTTP/1.1 200 OK

Content

4.获取产品列表

企业管理员获取自己企业下产品的列表信息。

Request

URL

GET /v2/products

Header

Content-Type:application/json
Access-Token:"调用凭证"

Content

Response

Header

HTTP/1.1 200 OK

Content

[
	    {
	        "id": "产品ID",
	        "name": "产品名称",
	        "description": "产品描述",
	        "link_type": "设备连接类型",
			"mode":"产品的型号",
	        "is_release": "是否发布",
	        "is_registerable": "是否允许用户注册设备"
			"is_active_register":"是否允许通过激活注册设备",
			"is_allow_multi_admin":"是否允许设备多个管理员",
			"user_role_authority":"普通用户对设备的权限,默认RW",
			"create_time":"创建时间",
			"type":"产品类型",
			"quota":"设备配额总数",
			"scan_mode":"扫描订阅策略,枚举值,见附录",
			"pics":["http://www.xlink.cn/pic1","http://www.xlink.cn/pic2"],
			"qrcode":"产品二维码",
			"extend":{{keay}:{value}},
			"device_type":"设备类型",
			"mode":"产品型号",
			"extend":"产品拓展信息",
			"is_gateway_device":"是否为网关设备",
			"categories":["产品品类"],
			"visibility":"产品可见权限",
			"is_home_product": "是否为首页产品",
			"browse_time": "2018-05-25T17:58:10.77Z",
			"os_type":"os类型"
	 }
	]


字段是否必须描述
id产品ID
name产品名称,32个字符以内
description产品描述,250个字符以内
link_type设备连接类型,见产品附录1
mode产品的型号,长度在64个字符以内
is_release是否发布,布尔值,true或false
is_registerable是否允许用户注册设备
is_active_register是否允许通过激活注册设备
is_allow_multi_admin否允许设备多个管理员
create_time产品创建时间
user_role_authority普通用户对设备的权限,默认RW
type产品类型,见产品附录5
quota设备配额总数,整数
scan_mode扫描订阅策略,枚举值,见附录
pics产品图片列表
qrcode产品二维码
extend扩展属性
device_type
设备类型
is_gateway_device
是否为网关设备
categories产品品类
visibility产品可见权限
is_home_product是否为首页产品
browse_time最近浏览时间
os_typeos类型

5.获取产品详细信息

企业管理员根据产品标识product_id url中获取单个产品详细信息。

Request

URL

GET /v2/product/{product_id}
字段是否必须描述
product_id产品ID,32个字符

Header

Content-Type:application/json
Access-Token:"调用凭证"

Content

Response

Header

HTTP/1.1 200 OK

Content

{
	    "id": "产品ID",
	    "name": "产品名称",
	    "description": "产品描述",
	    "link_type": "设备连接类型",
		"mode":"产品的型号",
	    "is_release": "是否发布",
	    "is_registerable": "是否允许用户注册设备",
		"is_active_register":"是否允许通过激活注册设备",
		"is_allow_multi_admin":"是否允许设备多个管理员",
		"user_role_authority":"普通用户对设备的权限,默认RW",
		"create_time":"创建时间",
		"type":"产品类型",
		"quota":"设备配额总数",
		"scan_mode":"扫描订阅策略,枚举值,见附录",
		"pics":["http://www.xlink.cn/pic1","http://www.xlink.cn/pic2"],
		"qrcode":"产品二维码",
		"device_type":"设备类型",
		"mode":"产品型号",
		"extend":"产品拓展信息",
		"is_gateway_device":"是否为网关设备",
		"categories":["产品品类"],
		"visibility":"产品可见权限",
		"is_home_product": "是否为首页产品",
		"browse_time": "2018-05-25T17:58:10.77Z",
		"os_type":"os类型"	
 }


字段是否必须描述
id产品ID
name产品名称,32个字符以内
description产品描述,250个字符以内
link_type设备连接类型,见产品附录1
mode产品的型号,长度在64个字符以内
is_release是否发布
is_registerable是否允许用户注册设备
is_active_register是否允许通过激活注册设备
is_allow_multi_admin否允许设备多个管理员
create_time产品创建时间
user_role_authority普通用户对设备的权限,默认RW
type产品类型,见产品附录5
quota设备配额总数,整数
scan_mode扫描订阅策略,枚举值,见附录
pics产品图片列表
qrcode产品二维码
extend扩展属性
device_type
设备类型
is_gateway_device
是否为网关设备
categories产品品类
visibility产品可见权限
is_home_product是否为首页产品
browse_time最近浏览时间
os_typeos类型

6.获取产品密钥

企业管理员根据产品产品标识product_id url中获取产品密钥。

Request

URL

GET /v2/product/{product_id}/key
字段是否必须描述
product_id产品ID,32个字符

Header

Content-Type:application/json
Access-Token:"调用凭证"

Content

Response

Header

HTTP/1.1 200 OK

Content

{
    "key":"产品密钥"
}
字段是否必须描述
key产品密钥

7.添加固件版本

企业管理员为某个产品添加一个固件版本,需要指定固件型号、 固件版本号、固件文件地址、固件文件MD5值、固件文件大小、描述、发布日期以及是否发布。

Request

URL

POST /v2/product/{product_id}/firmware
字段是否必须描述
product_id产品ID,32个字符

Header

Content-Type:application/json
Access-Token:"调用凭证"

Content

{
    "mod": "固件型号",
    "version": "固件版本号",
    "file_url": "固件文件地址",
    "file_md5": "固件文件MD5值",
    "file_size": "固件文件大小",
    "description": "描述",
    "release_date": "发布日期",
    "is_release": "是否发布",
    "type" : "固件类型",
    "identify":"用来定位多MCU或多子设备的情况"
}
字段是否必须描述
mod固件型号,20个字符以内
version固件版本号,32位整形
file_url固件文件地址,250个字符以内
file_md5固件文件MD5值
file_size固件文件大小
description描述,250字符以内
release_date指定发布日期,例:2015-10-09T08 : 15 : 40.843Z
is_release是否发布,布尔类型,true或false
type固件类型,新增,见附件设备固件类型, 默认为wifi
identify用来定位多MCU或多子设备的情况, 数字, type为mcu或多子设备时必传, version/type/identify联合唯一

Response

Header

HTTP/1.1 200 OK

Content

{
    "id": "固件版本ID",
    "mod": "固件型号",
    "version": "固件版本号",
    "file_url": "固件文件地址",
    "file_md5": "固件文件MD5值",
    "description": "描述",
    "release_date": "固件发布日期",
    "create_date": "固件创建日期",
    "is_release": "是否发布",
    "type" : "固件类型",
    "identify":"用来定位多MCU或多子设备的情况"
}
字段是否必须描述
id固件ID
mod固件型号,20个字符以内
version固件版本号,32位整形
file_url固件文件地址,250个字符以内
file_md5固件文件MD5值
file_size固件文件大小
description描述,250字符以内
release_date固件发布日期,例:2015-10-09T08 : 15 : 40.843Z
create_date固件创建日期,例:2015-10-09T08 : 15 : 40.843Z
is_release是否发布,布尔值,true或false
type固件类型,新增,见附件设备固件类型, 默认为wifi
identify用来定位多MCU或多子设备的情况, 数字, type为mcu或多子设备时存在, version/type/identify联合唯一, 默认为0

8.编辑固件版本

企业管理员根据产品标识product_id以及版本标识firmware_id url中修改固件版本中的固件型号、固件版本号、固件文件地址、固件文件MD5值、固件文件大小、描述、固件发布日期以及是否发布。

Request

URL

PUT /v2/product/{product_id}/firmware/{firmware_id}
字段是否必须描述
product_id产品ID,32个字符
firmware_id固件版本ID

Header

Content-Type:application/json
Access-Token:"调用凭证"

Content

{
    "mod":"固件型号",
    "version":"固件版本号",
    "file_url":"固件文件地址",
    "file_md5":"固件文件MD5值",
    "file_size":"固件文件大小",
    "description":"描述",
    "release_date":"固件发布日期",
    "is_release":"是否发布"
}
字段是否必须描述
mod固件型号,20个字符以内
version固件版本号,32位整形
file_url固件文件地址,250个字符以内
file_md5固件文件MD5值
file_size固件文件大小
description描述,250字符以内
release_date固件发布日期,例:2015-10-09T08 : 15 : 40.843Z
is_release是否发布,布尔值,true或false

Response

Header

HTTP/1.1 200 OK

Content

{
    "id": "固件版本ID",
    "mod": "固件型号",
    "version": "固件版本号",
    "file_url": "固件文件地址",
    "file_md5": "固件文件MD5值",
    "file_size": "固件文件大小",
    "description": "描述",
    "release_date": "固件发布日期",
    "create_date": "固件创建日期",
    "is_release": "是否发布"
}
字段是否必须描述
id固件ID
mod固件型号,20个字符以内
version固件版本号,32位整形
file_url固件文件地址,250个字符以内
file_md5固件文件MD5值
file_size固件文件大小
description描述,250字符以内
release_date固件发布日期,例:2015-10-09T08 : 15 : 40.843Z
create_date固件创建日期,例:2015-10-09T08 : 15 : 40.843Z
is_release是否发布,布尔值,true或false

9.删除固件版本

企业管理员根据产品标识product_id以及版本标识firmware_id url中 删除指定产品的指定固件版本。

Request

URL

DELETE /v2/product/{product_id}/firmware/{firmware_id}
字段是否必须描述
product_id产品ID,32个字符
firmware_id固件版本ID

Header

Content-Type:application/json
Access-Token:"调用凭证"

Content

Response

Header

HTTP/1.1 200 OK

Content

10.获得固件版本列表

企业管理员根据产品标识product_id url中查询产品的所有固件版本。

Request

URL

GET /v2/product/{product_id}/firmwares?offset={offset}&limit={limit}
字段是否必须描述
product_id产品ID,32个字符

Header

Content-Type:application/json
Access-Token:"调用凭证"

Content

Respones

Header

HTTP/1.1 200 OK

Content

[
    {
        "id": "固件版本ID",
        "mod": "固件型号",
        "version": "固件版本号",
        "file_url": "固件文件地址",
        "file_md5": "固件文件MD5值",
        "file_size": "固件文件大小",
        "description": "描述",
        "release_date": "固件发布日期",
        "create_date": "固件创建日期",
        "is_release": "是否发布",
        "type" : "固件类型",
        "identify":"用来定位多MCU或多子设备的情况",
"from_version_by_task":"是否已经被升级任务作为启始版本",
"used_by_running_task":"是否已经被处于升级中的升级任务使用, 可以用于标识改固件不能被编辑" } ]
字段是否必须描述
id固件ID
mod固件型号,20个字符以内
version固件版本号,32位整形
file_url固件文件地址,250个字符以内
description描述,250字符以内
release_date固件发布日期,例:2015-10-09T08 : 15 : 40.843Z
create_date固件创建日期,例:2015-10-09T08 : 15 : 40.843Z
is_release是否发布,布尔值,true或false
file_md5固件文件Md5
file_size固件文件大小
description描述,250字符以内
release_date固件发布日期,例:2015-10-09T08 : 15 : 40.843Z
create_date固件创建日期,例:2015-10-09T08 : 15 : 40.843Z
is_release是否发布,布尔值,true或false
type固件类型,新增,见附件设备固件类型, 默认为wifi
identify用来定位多MCU或多子设备的情况, 数字, version/type/identify联合唯一, 默认为0
from_version_by_task是否已经被升级任务作为启始版本
used_by_running_task是否已经被处于升级中的升级任务使用, 可以用于标识改固件不能被编辑

11.添加数据端点

企业管理员为企业下的某个产品添加一个新的数据端点,包括数据端点名称、数据类型、数据端点索引、描述、符号以及是否收集端点数据。

Request

URL

POST /v2/product/{product_id}/datapoint
字段是否必须描述
product_id产品ID,32个字符

Header

Content-Type:application/json
Access-Token:"调用凭证"

Content

{
    "name":"数据端点名称",
    "type":"数据类型",
    "index":"数据端点索引",
    "description":"描述",
    "symbol":"符号",
    "is_collect":"是否收集端点数据",
    "min":"数据端点取值范围,最小值",
    "max":"数据端点取值范围,最大值",
    "is_read":"数据端点是否可读",
    "is_write":"数据端点是否可写",
    "default_value":"数据端点默认值",
    "expression":"动态计算数据端点表达式",
    "source":"数据来源类型",
"permission_list":[1,2],
"field_name":"字段名称"
}


字段是否必须描述
name数据端点名称,32个字符以内
type数据类型,见产品附录2
index数据端点索引,32位数字整形
description数据端点描述,250个字符以内
symbol符号,10个字符以内
is_collect是否收集端点数据,默认:否
min数据端点取值范围,最小值
max数据端点取值范围,最大值
is_read布尔值,数据端点是否可读
is_write布尔值,数据端点是否可写
default_valuestring, 数据端点默认值
source数据来源类型,见产品附录6
expressionstring, 数据来源为计算类型时,数据端点表达式, 假如要引用其他数据端点:@index@ + 1, 加入要引用所属产品拓展属性则: #property# + 2
permission_list
可更新该数据端点的权限集合, 1:企业成员,2:企业授权,3:用户, 4:设备, 5:平台, 其中设备上报类型数据端点只能是4, 计算型数据端点只能是5,应用型数据端点可任意
field_name
字段名称

Response

Header

HTTP/1.1 200 OK

Content

{
    "id": "数据端点ID",
    "name": "数据端点名称",
    "type": "数据类型",
    "index": "数据端点索引",
    "description": "描述",
    "symbol": "符号",
    "is_collect": "是否收集端点数据",
    "min":"数据端点取值范围,最小值",
    "max":"数据端点取值范围,最大值",
    "is_read":"数据端点是否可读",
    "is_write":"数据端点是否可写",
    "default_value":"数据端点默认值",
    "expression":"动态计算数据端点表达式",
    "source":"数据来源类型",

       "ui_visible":{
           "state":"设备状态可见",
           "control":"远程控制可见"
       },
      "field_name":"字段名称",
     "is_system":"是否为系统数据端点"

}
字段是否必须描述
id数据端点ID
name数据端点名称,32个字符以内
type数据类型,见产品附录2
index数据端点索引,32位数字整形
description数据端点描述,250个字符以内
symbol符号,10个字符以内
is_collect是否收集端点数据,默认:否
min数据端点取值范围,最小值,默认为0
max数据端点取值范围,最大值,默认为0
is_read布尔值,数据端点是否可读
is_write布尔值,数据端点是否可写
default_valuestring, 数据端点默认值
source数据来源类型,见产品附录6
expressionstring, 数据来源为计算类型时,数据端点表达式, 假如要引用其他数据端点:@index@ + 1, 加入要引用所属产品拓展属性则: #property# + 2
permission_list可更新该数据端点的权限集合, 1:企业成员,2:企业授权,3:用户, 4:设备, 5:平台, 其中设备上报类型数据端点只能是4, 计算型数据端点只能是5,应用型数据端点可任意
ui_visibleui页面是否显示, 布尔值
field_name字段名称
is_system是否为系统数据端点

12.修改数据端点

企业管理员根据产品标识product_id以及数据端点标识datapoint_id url中 进行修改数据端点相应信息,包括数据端点名称、数据类型、数据端点索引、描述、符号、是否收集端点数据,产品已发布情况下不可修改。

Request

URL

PUT /v2/product/{product_id}/datapoint/{datapoint_id}
字段是否必须描述
product_id产品ID,32个字符
datapoint_id数据端点ID

Header

Content-Type:application/json
Access-Token:"调用凭证"

Content

{
	    "name": "数据端点名称",
	    "type": "数据类型",
	    "index": "数据端点索引",
	    "description": "描述",
	    "symbol": "符号",
	    "is_collect": "是否收集端点数据",
		"min":"数据端点取值范围,最小值",
		"max":"数据端点取值范围,最大值",
		"is_read":"数据端点是否可读",
		"is_write":"数据端点是否可写",
		"default_value":"数据端点默认值",
		"expression":"动态计算数据端点表达式",
		"ui_visible":{
			"state":"设备状态可见",
			"control":"远程控制可见"
		},
		"field_name":"字段名称"
	}


字段是否必须描述
name数据端点名称,32个字符以内
type数据类型,见产品附录2
index数据端点索引,16位整形
description数据端点描述,250个字符内
symbol符号,10个字符以内
is_collect是否收集端点数据,默认:否,
min数据端点取值范围,最小值,默认为0
max数据端点取值范围,最大值,默认为0
is_read布尔值,数据端点是否可读
is_write布尔值,数据端点是否可写
default_valuestring, 数据端点默认值
expressionstring, 数据来源为计算类型时,数据端点表达式, 假如要引用其他数据端点:@index@ + 1, 加入要引用所属产品拓展属性则: #property# + 2
permission_list可更新该数据端点的权限集合, 1:企业成员,2:企业授权,3:用户, 4:设备, 5:平台, 其中设备上报类型数据端点只能是4, 计算型数据端点只能是5,应用型数据端点可任意
ui_visibleui页面是否显示, 布尔值
field_name字段名称

Response

Header

HTTP/1.1 200 OK

Content

13.删除数据端点

通过产品ID和数据端点标识ID删除数据端点。

Request

URL

DELETE /v2/product/{product_id}/datapoint/{datapoint_id}
字段是否必须描述
product_id产品ID,32个字符
datapoint_id数据端点ID

Header

Content-Type:application/json
Access-Token:"调用凭证"

Content

Response

Header

HTTP/1.1 200 OK

Content

14.获取数据端点

企业管理员根据产品标识product_id以及数据端点标识datapoint_id url中 获取数据端点信息。

Request

URL

GET /v2/product/{product_id}/datapoint/{datapoint_id}
字段是否必须描述
product_id产品ID,32个字符
datapoint_id数据端点ID

Header

Content-Type:application/json
Access-Token:"调用凭证"

Content

Response

Header

HTTP/1.1 200 OK

Content

{
	    "id": "数据端点ID",
	    "name": "数据端点名称",
	    "type": "数据类型",
	    "index": "数据端点索引",
	    "description": "描述",
	    "symbol": "符号",
	    "is_collect": "是否收集端点数据",
		"min":"数据端点取值范围,最小值",
		"max":"数据端点取值范围,最大值",
		"is_read":"数据端点是否可读",
		"is_write":"数据端点是否可写",
		"default_value":"数据端点默认值",
		"expression":"动态计算数据端点表达式",
		"source":"数据来源类型",
		"ui_visible":{
			"state":"设备状态可见",
			"control":"远程控制可见"
		},
		"field_name":"字段名称",
		"is_system":"是否为系统数据端点"
	}


字段是否必须描述
id数据端点ID
name数据端点名称,32个字符以内
type数据类型,见产品附录2
index数据端点索引,16位整形
description数据端点描述,250个字符内
symbol符号,10个字符以内
is_collect是否收集端点数据,默认:否
min数据端点取值范围,最小值
max数据端点取值范围,最大值
is_read布尔值,数据端点是否可读
is_write布尔值,数据端点是否可写
default_valuestring, 数据端点默认值
source数据来源类型,见产品附录6
expressionstring, 数据来源为计算类型时,数据端点表达式, 假如要引用其他数据端点:@index@ + 1, 加入要引用所属产品拓展属性则: #property# + 2
permission_list

可更新该数据端点的权限集合, 1:企业成员,2:企业授权,3:用户, 4:设备, 5:平台, 其中设备上报类型数据端点只能是4, 计算型数据端点只能是5,应用型数据端点可任意

ui_visibleui页面是否显示, 布尔值
field_name字段名称
is_system是否为系统数据端点

15.获取数据端点列表

根据product_id获取某种产品的数据端点列表。

Request

URL

GET /v2/product/{product_id}/datapoints
字段是否必须描述
product_id产品ID,32个字符

Header

Content-Type:application/json
Access-Token:"企业调用凭证/用户调用凭证/设备调用凭证"

Content

Response

Header

HTTP/1.1 200 OK

Content

[
	    {
	        "id": "数据端点ID",
	        "name": "数据端点名称",
	        "type": "数据类型",
	        "index": "数据端点索引",
	        "description": "描述",
	        "symbol": "符号",
	        "is_collect": "是否收集端点数据",
			"min":"数据端点取值范围,最小值",
			"max":"数据端点取值范围,最大值",
			"is_read":"数据端点是否可读",
			"is_write":"数据端点是否可写",
			"default_value":"数据端点默认值",
			"expression":"动态计算数据端点表达式",
			"source":"数据来源类型",
			"ui_visible":{
				"state":"设备状态可见",
				"control":"远程控制可见"
			},
			"field_name":"字段名称",
			"is_system":"是否为系统数据端点"
	    }
	]


字段是否必须描述
id数据端点ID
name数据端点名称,32个字符以内
type数据类型,见产品附录2
index数据端点索引,16位整形
description数据端点描述,250个字符内
symbol符号,10个字符以内
is_collect是否收集端点数据,默认:否,
min数据端点取值范围,最小值
max数据端点取值范围,最大值
is_read布尔值,数据端点是否可读
is_write布尔值,数据端点是否可写
default_valuestring, 数据端点默认值
source数据来源类型,见产品附录6
expressionstring, 数据来源为计算类型时,数据端点表达式, 假如要引用其他数据端点:@index@ + 1, 加入要引用所属产品拓展属性则: #property# + 2
permission_list

可更新该数据端点的权限集合, 1:企业成员,2:企业授权,3:用户, 4:设备, 5:平台, 其中设备上报类型数据端点只能是4, 计算型数据端点只能是5,应用型数据端点可任意

ui_visibleui页面是否显示, 布尔值
field_name字段名称
is_system是否为系统数据端点

16.创建数据转发规则

企业管理员为企业下的某个产品添加一个新的数据转发规则,包括转发类型、转发外部URL地址、外部URL地址验证令牌、关注的数据包类型列表,转发规则主要用户收集产品设备产生的相关数据。

Request

URL

POST /v2/product/{product_id}/dds
字段是否必须描述
product_id产品ID,32个字符

Header

Content-Type:application/json
Access-Token:"调用凭证"

Content

{
    "data_type": [
        "1",
        "2",
        "3",
        "4",
        "5"
    ],
    "destination": {
        "type": "转发类型",
        "url": "转发URL地址",
        "token": "URL地址验证令牌"
    }
}
字段是否必须描述
type转发类型,见产品附录3
url转发外部URL地址
token外部URL地址验证令牌
data_type关注的数据包类型列表,见产品附录4

Response

Header

HTTP/1.1 200 OK

Content

{
    "id": "转发规则ID",
    "data_type": [
        "1",
        "2",
        "3",
        "4",
        "5"
    ],
    "destination": {
        "type": "转发类型",
        "url": "转发URL地址",
        "token": "URL地址验证令牌"
    }
}
字段是否必须描述
id转发规则ID
type转发类型,见产品附录3
url转发外部URL地址
token外部URL地址验证令牌
data_type关注的数据包类型列表,见产品附录4

17.获取数据转发规则列表

企业管理员根据产品标识product_id url中 获取属于该产品的所有转发规则。

Request

URL

GET /v2/product/{product_id}/dds_list
字段是否必须描述
product_id产品ID,32个字符

Header

Content-Type:application/json
Access-Token:"调用凭证"

Content

Response

Header

HTTP/1.1 200 OK

Content

{
    "count": "返回数量",
    "list": {
        "id": "转发规则ID",
  "status":"状态, 1:启用, 2:禁用",
"data_type": [ "1", "2", "3", "4", "5" ], "destination": { "type": "转发类型", "url": "转发URL地址", "token": "URL地址验证令牌" } } }
字段是否必须描述
count返回数量
id转发规则ID
type转发类型,见产品附录3
url转发外部URL地址
token外部URL地址验证令牌
data_type

关注的数据包类型列表,见产品产品附录4

status启用状态

18.修改数据转发规则

企业管理员根据产品标识product_id以及dispatch_id url中修改数据转发规则,可修改的有转发类型、转发外部URL地址、外部URL地址验证令牌以及关注的数据包类型列表。

Request

URL

PUT /v2/product/{product_id}/dds/{dispatch_id}
字段是否必须描述
product_id产品ID,32个字符
dispatch_id数据转发规则ID

Header

Content-Type:application/json
Access-Token:"调用凭证"

Content

{
 "data_type": [ "1", "2", "3", "4", "5" ], "destination": { "type": "转发类型", "url": "转发URL地址", "token": "URL地址验证令牌" },
    "status":"状态, 1:启用, 2:禁用"
 }


字段是否必须描述
type转发类型,见产品附录3
url转发外部URL地址
token外部URL地址验证令牌
data_type关注的数据包类型列表,见产品产品附录4
status启用状态

Response

Header

HTTP/1.1 200 OK

Content

{
    "id": "转发规则ID",
 "status":"状态, 1:启用, 2:禁用",
"data_type": [ "1", "2", "3", "4", "5" ], "destination": { "type": "转发类型", "url": "转发URL地址", "token": "URL地址验证令牌" } }
字段是否必须描述
id转发规则ID
type转发类型,见产品附录3
url转发外部URL地址
token外部URL地址验证令牌
data_type关注的数据包类型列表,见产品产品附录4
status启用状态

19.删除数据转发规则

企业管理员根据产品标识product_id以及dispatch_id url中删除数据转发规则。

Request

URL

DELETE /v2/product/{product_id}/dds/{dispatch_id}
字段是否必须描述
product_id产品ID,32个字符
dispatch_id数据转发规则ID

Header

Content-Type:application/json
Access-Token:"调用凭证"

Content

Response

Header

HTTP/1.1 200 OK

Content

20.添加设备

企业管理员指定产品标识product_id url中 为在某个产品下添加一个设备。

Request

URL

POST /v2/product/{product_id}/device
字段是否必须描述
product_id产品ID,32个字符

Header

Content-Type:"application/json"
Access-Token:"调用凭证"

Content

{
    "mac":"MAC地址",
    "sn":"序列号",
    "name":"设备别名",
    "domain":"自定义域",
    "tags":["tag1","tag2"]
}
字段是否必须描述
macMAC地址(在一个产品下必须唯一)
sn序列号
name设备别名
domain自定义域,一般用于将设备分成不同的范围,以便于管理与查找
tags设备标签

Response

Header

HTTP/1.1 200 OK

Content

{
    "id": "设备ID",
    "mac": "设备MAC地址"
}

21.导入设备

企业管理员指定产品标识product_id url中 为在某个产品 批量导入设备,如果导入的设备已经存在,则忽略。

Request

URL

POST /v2/product/{product_id}/device_batch
字段是否必须描述
product_id产品ID,32个字符

Header

Content-Type:"application/json"
Access-Token:"调用凭证"

Content

[
    "MAC地址1",
    "MAC地址2"
]

Response

Header

HTTP/1.1 200 OK

Content

{
    "devices": [
        {
            "id": "设备ID",
            "mac": "设备MAC"
        },
        {
            "id": "设备ID",
            "mac": "设备MAC"
        }
    ]
}

22.获取设备信息

企业管理员根据指定产品标识product_id以及设备标识device_id url中 获取单个设备详细信息。

Request

URL

GET /v2/product/{product_id}/device/{device_id}

Header

Content-Type:"application/json"
Access-Token:"调用凭证"

Content

Response

Header

HTTP/1.1 200 OK

Content

{
    "id": "设备ID",
    "mac": "MAC地址",
    "name": "设备名称",
    "is_active": "是否激活",
    "active_date": "激活时间",
    "is_online": "是否在线",
    "last_login": "最近登录时间",
    "last_login_ip": "最近登录IP",
    "mcu_mod": "MCU型号",
    "mcu_version": "MCU版本号",
    "firmware_mod": "固件