产品管理

2025/10/12大约 10 分钟

产品管理

创建产品

POST	/admin-api/iot/product/create

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
productName	产品品类	json	true	string
nodeType	节点类型	json	true	int32
networkType	联网类型	json	true	int32
productCateId	产品分类Id	json	false	string
dynReg	是否开启动态注册；1:开启，0:关闭	json	false	int32
productImg	产品图片	json	false	long
productDesc	产品描述	json	false	string
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	创建成功返回产品Id	long
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": 1419193028976640,
  "msg": ""
}

获取产品列表

GET	/admin-api/iot/product/list

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
productCateId	产品品类Id，用于过滤特性Id产品品类的产品	query	false	string
productName	产品名称，模糊查询产品名称	query	false	string
productKey	查询特定值的productKey产品	query	false	string
nodeType	节点类型	query	false	string
networkType	联网类型	query	false	int32
dynReg	查询是否动态注册的产品，可选值1或0	query	false	int32
productDesc	描述，模糊搜索productDesc内容	query	false	string
createTime	创建时间时间范围，示例值（2024-11-12 00:00:00 - 2024-11-29 23:59:59）	query	false	array[datatime]
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	数据体	array
---id	产品id	long
---productName	产品名称	string
---productKey	productKey	string
---productSecret	productSecret，数据已脱敏	string
---productCateId	产品品类Id	long
---productCateName	产品品类名称	string
---nodeType	节点类型	int
---networkType	联网类型	int
---deviceCounts	该产品下拥有多少台设备	long
---dynReg	是否开启动态注册	int
---productImg	产品图片	string
---productDesc	产品描述	string
---createTime	创建时间，时间戳	long
msg	状态消息	string

响应示例

{
    "status": 0,
    "code": 0,
    "data": [{
  	"productCateId": 1366004557963264,
  	"productName": "智能插座",
  	"productKey": "ngeQ6k",
  	"productSecret": "ecfc7fab93cf48559cff1825ac461b5a",
  	"productImg": null,
  	"nodeType": 1,
  	"networkType": 1,
  	"dynReg": 0,
  	"productDesc": null,
  	"createTime": 1700313329000,
  	"id": 1392896679247872,
  	"productCateName": "智能家具"
     },
     {
  	"productCateId": 1390387009978368,
  	"productName": "wifi控制一路继电器",
  	"productKey": "3c5fgd",
  	"productSecret": "4bb996152d0b450cb08ca538012e4b1f",
  	"productImg": null,
  	"nodeType": 1,
  	"networkType": 1,
  	"dynReg": 0,
  	"productDesc": "带本地定时的远程wifi控制一路继电器",
  	"createTime": 1697249831000,
  	"id": 1390387061211136,
  	"productCateName": "远程控制继电器类"
     }
    ],
    "msg": ""
}

获取产品分页

GET	/admin-api/iot/product/page

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
pageNo	页码，从 1 开始,示例值(1)	query	true	int32
pageSize	每页条数，最大值为 100,示例值(10)	query	true	int32
productCateId	产品品类Id，用于过滤特性Id产品品类的产品	query	false	string
productName	产品名称，模糊查询产品名称	query	false	string
productKey	查询特定值的productKey产品	query	false	string
nodeType	节点类型	query	false	string
networkType	联网类型	query	false	int32
dynReg	查询是否动态注册的产品，可选值1或0	query	false	int32
productDesc	描述，模糊搜索productDesc内容	query	false	string
createTime	创建时间时间范围，示例值（2024-11-12 00:00:00 - 2024-11-29 23:59:59）	query	false	array[datatime]
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	创建成功返回产品Id	object
---total	返回结果条数	int
---list	返回数据列表	array
------id	产品id	long
------productName	产品名称	string
------productKey	productKey	string
------productSecret	productSecret，数据已脱敏	string
------productCateId	产品品类Id	long
------productCateName	产品品类名称	string
------deviceCounts	该产品下拥有多少台设备	long
------nodeType	节点类型	int
------networkType	联网类型	int
------dynReg	是否开启动态注册	int
------productImg	产品图片	string
------productDesc	产品描述	string
------createTime	创建时间，时间戳	long
msg	状态消息	string

响应示例

{
    "status": 0,
    "code": 0,
    "data": {
        "list": [
            {
                "productCateId": null,
                "productName": "dwad",
                "productKey": "WSaSUV",
                "productSecret": "becd283e307140bf8c767e683d21bd44",
                "productImg": null,
                "nodeType": 1,
                "networkType": 1,
                "dynReg": 0,
                "productDesc": null,
                "createTime": 1726839582000,
                "id": 1414626985410560,
                "productCateName": null
            },
            {
                "productCateId": 1366004557963264,
                "productName": "智能插座",
                "productKey": "ngeQ6k",
                "productSecret": "ecfc7fab93cf48559cff1825ac461b5a",
                "productImg": null,
                "nodeType": 1,
                "networkType": 1,
                "dynReg": 0,
                "productDesc": null,
                "createTime": 1700313329000,
                "id": 1392896679247872,
                "productCateName": "智能家具"
            },
            {
                "productCateId": 1390387009978368,
                "productName": "wifi控制一路继电器",
                "productKey": "3c5fgd",
                "productSecret": "4bb996152d0b450cb08ca538012e4b1f",
                "productImg": null,
                "nodeType": 1,
                "networkType": 1,
                "dynReg": 0,
                "productDesc": "带本地定时的远程wifi控制一路继电器",
                "createTime": 1697249831000,
                "id": 1390387061211136,
                "productCateName": "远程控制继电器类"
            },
            {
                "productCateId": null,
                "productName": "remoteCard",
                "productKey": "kza2ib",
                "productSecret": "a69c5069ad4c463aa8ad500a520dcbef",
                "productImg": null,
                "nodeType": 1,
                "networkType": 1,
                "dynReg": 0,
                "productDesc": null,
                "createTime": 1667486104000,
                "id": 1366004616577024,
                "productCateName": null
            }
        ],
        "total": 4
    },
    "msg": ""
}

获取产品

GET	/admin-api/iot/product/get

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
id	产品id	query	true	long
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	数据体	object
---id	产品id	long
---productName	产品名称	string
---productKey	productKey	string
---productSecret	productSecret，数据已脱敏	string
---productCateId	产品品类Id	long
---productCateName	产品品类名称	string
---deviceCounts	该产品下拥有多少台设备	long
---nodeType	节点类型	int
---networkType	联网类型	int
---dynReg	是否开启动态注册	int
---productImg	产品图片	string
---productDesc	产品描述	string
---createTime	创建时间，时间戳	long
msg	状态消息	string

响应示例

{
    "status": 0,
    "code": 0,
    "data": {
  	"productCateId": 1390387009978368,
  	"productName": "wifi控制一路继电器",
  	"productKey": "3c5fgd",
  	"productSecret": "4bb996152d0b450cb08ca538012e4b1f",
  	"productImg": null,
  	"nodeType": 1,
  	"networkType": 1,
  	"dynReg": 0,
  	"productDesc": "带本地定时的远程wifi控制一路继电器",
  	"createTime": 1697249831000,
  	"id": 1390387061211136,
  	"productCateName": "远程控制继电器类"
     },
    "msg": ""
}

更新产品

PUT	/admin-api/iot/product/update

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
id	要更新的品类id	json	true	long
productCateId	产品分类Id	json	false	string
dynReg	是否开启动态注册；1:开启，0:关闭	json	false	int32
productImg	产品图片	json	false	long
productDesc	产品描述	json	false	string
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	更新成功返回true	boolean
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": true,
  "msg": ""
}

删除产品分类

DELETE	/admin-api/iot/product/delete

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
id	要删除的产品id	json	true	long
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	删除成功返回true	boolean
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": true,
  "msg": ""
}

更新动态注册状态

PUT	/admin-api/iot/product/dyn-reg

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
id	要更新的品类id	json	true	long
dynReg	是否开启动态注册；1:开启，0:关闭	json	true	int32
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	更新成功返回消息	string
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": "打开设备动态注册成功",
  "msg": ""
}

获取产品秘钥

GET	/admin-api/iot/product/get-secret

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
id	产品id	query	true	long
code	验证码，获取验证码请见下文：获取产品秘钥验证码	query	true	string
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	产品秘钥	string
msg	状态消息	string

响应示例{

    "status": 0,
    "code": 0,
    "data": "4bb996152d0b450cb08ca538012e4b1f",
    "msg": ""
}

获取产品秘钥验证码

POST	/admin-api/iot/product/send-sms-code-get-secret

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
scene	固定值为100，标识获取产品秘钥的场景验证码	json	true	int
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	true代表获取验证码成功	boolean
msg	状态消息	string

响应示例{

    "status": 0,
    "code": 0,
    "data": true,
    "msg": ""
}

获取产品物模型

GET	/admin-api/iot/product/get-product-model

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
id	产品id	query	true	long
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	数据体	object
---id	产品id	long
---productName	产品名称	string
---productKey	productKey	string
---productSecret	productSecret，数据已脱敏	string
---productCateId	产品品类Id	long
---productCateName	产品品类名称	string
---deviceCounts	该产品下拥有多少台设备	long
---nodeType	节点类型	int
---networkType	联网类型	int
---dynReg	是否开启动态注册	int
---productImg	产品图片	string
---productDesc	产品描述	string
---createTime	创建时间，时间戳	long
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": {
    "productKey": "WSaSUV",
    "properties": [
      {
        "name": "开机状态",
        "identifier": "power_on_status",
        "tags": "[{\"value\":0,\"desc\":\"已关机\"},{\"value\":1,\"desc\":\"已开机\"}]",
        "icon": null,
        "accessMode": 1,
        "description": null,
        "dataType": 5,
        "block": null
      },
      {
        "name": "testint",
        "identifier": "testint",
        "tags": null,
        "icon": null,
        "accessMode": 2,
        "description": null,
        "dataType": 1,
        "block": null
      },
      {
        "name": "testfloat",
        "identifier": "testfloat",
        "tags": null,
        "icon": null,
        "accessMode": 2,
        "description": null,
        "dataType": 2,
        "block": null
      },
      {
        "name": "testdouble",
        "identifier": "testdouble",
        "tags": null,
        "icon": null,
        "accessMode": 2,
        "description": null,
        "dataType": 3,
        "block": null
      },
      {
        "name": "testenum",
        "identifier": "testenum",
        "tags": "[{\"value\":1,\"desc\":\"test\"},{\"value\":2,\"desc\":\"testttt\"}]",
        "icon": null,
        "accessMode": 2,
        "description": null,
        "dataType": 4,
        "block": null
      },
      {
        "name": "teststruct",
        "identifier": "teststruct",
        "tags": "[{\"name\":\"test123\",\"identifier\":\"test123\",\"dataType\":1},{\"name\":\"test12344\",\"identifier\":\"dadwadwa\",\"dataType\":2}]",
        "icon": null,
        "accessMode": 2,
        "description": null,
        "dataType": 8,
        "block": null
      },
      {
        "name": "testarr",
        "identifier": "testarr",
        "tags": "{\"dataType\":8,\"length\":10,\"tags\":[{\"name\":\"test124\",\"identifier\":\"dadwad\",\"dataType\":2},{\"name\":\"teset1243\",\"identifier\":\"dwadwadww\",\"dataType\":4,\"tags\":[{\"value\":1,\"desc\":\"wdadwa\"},{\"value\":213,\"desc\":\"dwadwadwa\"}]}]}",
        "icon": null,
        "accessMode": 2,
        "description": null,
        "dataType": 9,
        "block": null
      }
    ],
    "services": [
      {
        "name": "开机",
        "identifier": "power_on_service",
        "callType": 2,
        "inputParams": "[]",
        "outputParams": "[]",
        "description": null,
        "icon": null,
        "block": null
      },
      {
        "name": "关机",
        "identifier": "power_off_service",
        "callType": 2,
        "inputParams": "[]",
        "outputParams": "[]",
        "description": null,
        "icon": null,
        "block": null
      },
      {
        "name": "强制关机",
        "identifier": "force_power_off_service",
        "callType": 2,
        "inputParams": "[]",
        "outputParams": "[]",
        "description": null,
        "icon": null,
        "block": null
      },
      {
        "name": "重启",
        "identifier": "restart_service",
        "callType": 2,
        "inputParams": "[]",
        "outputParams": "[]",
        "description": null,
        "icon": null,
        "block": null
      },
      {
        "name": "关闭灯光",
        "identifier": "close_led_service",
        "callType": 2,
        "inputParams": "[]",
        "outputParams": "[]",
        "description": null,
        "icon": null,
        "block": null
      },
      {
        "name": "打开灯光",
        "identifier": "open_led_service",
        "callType": 2,
        "inputParams": "[]",
        "outputParams": "[]",
        "description": null,
        "icon": null,
        "block": null
      }
    ],
    "events": [
      {
        "name": "开机事件",
        "identifier": "power_on_event",
        "outputParams": "[]",
        "description": null,
        "eventType": 1,
        "icon": null,
        "block": null
      },
      {
        "name": "关机事件",
        "identifier": "power_off_event",
        "outputParams": "[]",
        "description": null,
        "eventType": 1,
        "icon": null,
        "block": null
      }
    ]
  },
  "msg": ""
}