跳至主要內容

产品管理

xiaolizi大约 10 分钟

产品管理

创建产品

POST/admin-api/iot/product/create

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

请求参数

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

响应状态

状态码说明
200OK

响应参数

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

响应示例

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

获取产品列表

GET/admin-api/iot/product/list

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

请求参数

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

响应状态

状态码说明
200OK

响应参数

参数名称参数说明数据类型
status状态码，值为0正常，其他值为异常int
code结果同status一样，冗余字段int
data数据体array
---id产品idlong
---productName产品名称string
---productKeyproductKeystring
---productSecretproductSecret，数据已脱敏string
---productCateId产品品类Idlong
---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)querytrueint32
pageSize每页条数，最大值为 100,示例值(10)querytrueint32
productCateId产品品类Id，用于过滤特性Id产品品类的产品queryfalsestring
productName产品名称，模糊查询产品名称queryfalsestring
productKey查询特定值的productKey产品queryfalsestring
nodeType节点类型queryfalsestring
networkType联网类型queryfalseint32
dynReg查询是否动态注册的产品，可选值1或0queryfalseint32
productDesc描述，模糊搜索productDesc内容queryfalsestring
createTime创建时间时间范围，示例值（2024-11-12 00:00:00 - 2024-11-29 23:59:59）queryfalsearray[datatime]
Authorization认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda)
获取access_token请参考获取访问令牌		headertruestring

响应状态

状态码说明
200OK

响应参数

参数名称参数说明数据类型
status状态码，值为0正常，其他值为异常int
code结果同status一样，冗余字段int
data创建成功返回产品Idobject
---total返回结果条数int
---list返回数据列表array
------id产品idlong
------productName产品名称string
------productKeyproductKeystring
------productSecretproductSecret，数据已脱敏string
------productCateId产品品类Idlong
------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产品idquerytruelong
Authorization认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda)
获取access_token请参考获取访问令牌		headertruestring

响应状态

状态码说明
200OK

响应参数

参数名称参数说明数据类型
status状态码，值为0正常，其他值为异常int
code结果同status一样，冗余字段int
data数据体object
---id产品idlong
---productName产品名称string
---productKeyproductKeystring
---productSecretproductSecret，数据已脱敏string
---productCateId产品品类Idlong
---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要更新的品类idjsontruelong
productCateId产品分类Idjsonfalsestring
dynReg是否开启动态注册；1:开启，0:关闭jsonfalseint32
productImg产品图片jsonfalselong
productDesc产品描述jsonfalsestring
Authorization认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda)
获取access_token请参考获取访问令牌		headertruestring

响应状态

状态码说明
200OK

响应参数

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

响应示例

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

删除产品分类

DELETE/admin-api/iot/product/delete

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

请求参数

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

响应状态

状态码说明
200OK

响应参数

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

响应示例

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

更新动态注册状态

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

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

请求参数

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

响应状态

状态码说明
200OK

响应参数

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

响应示例

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

获取产品秘钥

GET/admin-api/iot/product/get

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

请求参数

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

响应状态

状态码说明
200OK

响应参数

参数名称参数说明数据类型
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，标识获取产品秘钥的场景验证码jsontrueint
Authorization认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda)
获取access_token请参考获取访问令牌		headertruestring

响应状态

状态码说明
200OK

响应参数

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

响应示例{

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

获取产品物模型

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

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

请求参数

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

响应状态

状态码说明
200OK

响应参数

参数名称参数说明数据类型
status状态码，值为0正常，其他值为异常int
code结果同status一样，冗余字段int
data数据体object
---id产品idlong
---productName产品名称string
---productKeyproductKeystring
---productSecretproductSecret，数据已脱敏string
---productCateId产品品类Idlong
---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": ""
}

上传产品物模型

小李子科技
Copyright © 2024 xiaolizi