联犀-things

新增产品

POST

/api/v1/things/product/info/create

things/product/infothingsProductInfo

请求参数

Header 参数

Ithings-Project-Id

string

可选

默认值:

Ithings-Token

string

可选

默认值:

app-code

string

可选

默认值:

device-id

string

可选

用户正在使用的设备ID(小程序,ios,安卓的设备ID)

Body 参数application/json

createdTime

string

创建时间只读

可选

productID

string

产品id 只读

可选

productName

string

产品名称

可选

productImg

string

产品图片

可选

isUpdateProductImg

boolean

可选

只有这个参数为true的时候才会更新产品图片,传参为产品图片的file path

authMode

integer <int64>

可选

认证方式:1:账密认证,2:秘钥认证

<= 2

deviceType

integer <int64>

可选

设备类型:1:直连设备,2:网关,3:子设备,4:监控设备

<= 4

deviceSchemaMode

integer <int64>

可选

设备物模型模式:1:手动创建,2:设备自动创建 3: 设备自动创建及上报无定义自动创建 4: 设备自动创建及上报无定义自动创建(数字类型只使用浮点)

<= 4

categoryID

integer <int64>

产品品类

可选

netType

integer <int64>

可选

通讯方式:1:其他,2:wi-fi,3:2G/3G/4G,4:5G,5:BLE,6:LoRaWAN,7:wifi+ble,8:有线网,9:4G+BLE

<= 10

protocolCode

string

可选

协议code,默认urMqtt,设备下发只会发送给主协议 urMqtt,urHttp,wumei,aliyun,huaweiyun,tuya

subProtocolCode

string

可选

子协议,主协议和子协议传输类型必须不相同, 设备控制下发只会发送给主协议, 当设备是音视频设备但是控制协议需要单独走的时候就可以把主协议定义为普通协议,子协议定义为音视频协议,这样就能实现音视频走音视频协议,控制走子协议

autoRegister

integer <int64>

可选

动态注册:1:关闭,2:打开,3:打开并自动创建设备

<= 3

secret

string

可选

动态注册产品秘钥只读

trialTime

string

可选

试用时间(单位为天,为0不限制)

desc

string

描述

可选

category

object (ProductCategory)

可选

integer <int64>

可选

parentID

integer <int64>

可选

idPath

array[integer <int64>]

只读

可选

name

string

可选

desc

string

描述

可选

headImg

string

用户头像

可选

isUpdateHeadImg

boolean

用户头像

可选

isLeaf

integer <int64>

可选

deviceCount

integer <int64>

设备数量

可选

children

array[object (ProductCategory) {10}]

可选

config

object (ProductConfig)

可选

productID

string

必需

devInit

object (DevInit)

可选

customUi

object

可选

自定义ui,key是端的类型(web-client mini-client) value是以下类型的对象{version:123(版本号,只读),isUpdateUi:bool(是否更新ui),path:string(前端路径,如果需要修改,需要将isUpdateUi置为true并在这个参数中传入压缩包的filePath)}

示例

{
    "createdTime": "string",
    "productID": "string",
    "productName": "string",
    "productImg": "string",
    "isUpdateProductImg": true,
    "authMode": 2,
    "deviceType": 4,
    "deviceSchemaMode": 4,
    "categoryID": 0,
    "netType": 10,
    "protocolCode": "string",
    "subProtocolCode": "string",
    "autoRegister": 3,
    "secret": "string",
    "trialTime": "string",
    "desc": "string",
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "sceneMode": "string",
    "status": 0,
    "bindLevel": 0,
    "protocolConf": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "subProtocolConf": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "protocol": {
        "id": 0,
        "name": "string",
        "code": "string",
        "type": "string",
        "transProtocol": "string",
        "desc": "string",
        "endpoints": [
            "string"
        ],
        "etcdKey": "string",
        "isEnableSyncProduct": 0,
        "isEnableSyncDevice": 0,
        "configFields": [
            {
                "id": 0,
                "group": "string",
                "key": "string",
                "label": "string",
                "isRequired": true,
                "sort": 0
            }
        ],
        "configInfos": [
            {
                "id": 0,
                "config": {},
                "desc": "string"
            }
        ],
        "productFields": [
            {
                "id": 0,
                "group": "string",
                "key": "string",
                "label": "string",
                "isRequired": true,
                "sort": 0
            }
        ],
        "deviceFields": [
            {
                "id": 0,
                "group": "string",
                "key": "string",
                "label": "string",
                "isRequired": true,
                "sort": 0
            }
        ]
    },
    "category": {
        "id": 0,
        "parentID": 0,
        "idPath": [
            0
        ],
        "name": "string",
        "desc": "string",
        "headImg": "string",
        "isUpdateHeadImg": true,
        "isLeaf": 0,
        "deviceCount": 0,
        "children": [
            {}
        ]
    },
    "config": {
        "productID": "string",
        "devInit": {
            "tenantCode": "string",
            "projectID": "string",
            "areaID": "string",
            "deptID": "string"
        }
    },
    "customUi": {}
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v1/things/product/info/create' \
--header 'Ithings-Project-Id: {{Ithings-Project-Id}}' \
--header 'Ithings-Token: {{iThings-token}}' \
--header 'app-code: {{appCode}}' \
--header 'device-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "createdTime": "string",
    "productID": "string",
    "productName": "string",
    "productImg": "string",
    "isUpdateProductImg": true,
    "authMode": 2,
    "deviceType": 4,
    "deviceSchemaMode": 4,
    "categoryID": 0,
    "netType": 10,
    "protocolCode": "string",
    "subProtocolCode": "string",
    "autoRegister": 3,
    "secret": "string",
    "trialTime": "string",
    "desc": "string",
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "sceneMode": "string",
    "status": 0,
    "bindLevel": 0,
    "protocolConf": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "subProtocolConf": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "protocol": {
        "id": 0,
        "name": "string",
        "code": "string",
        "type": "string",
        "transProtocol": "string",
        "desc": "string",
        "endpoints": [
            "string"
        ],
        "etcdKey": "string",
        "isEnableSyncProduct": 0,
        "isEnableSyncDevice": 0,
        "configFields": [
            {
                "id": 0,
                "group": "string",
                "key": "string",
                "label": "string",
                "isRequired": true,
                "sort": 0
            }
        ],
        "configInfos": [
            {
                "id": 0,
                "config": {},
                "desc": "string"
            }
        ],
        "productFields": [
            {
                "id": 0,
                "group": "string",
                "key": "string",
                "label": "string",
                "isRequired": true,
                "sort": 0
            }
        ],
        "deviceFields": [
            {
                "id": 0,
                "group": "string",
                "key": "string",
                "label": "string",
                "isRequired": true,
                "sort": 0
            }
        ]
    },
    "category": {
        "id": 0,
        "parentID": 0,
        "idPath": [
            0
        ],
        "name": "string",
        "desc": "string",
        "headImg": "string",
        "isUpdateHeadImg": true,
        "isLeaf": 0,
        "deviceCount": 0,
        "children": [
            {}
        ]
    },
    "config": {
        "productID": "string",
        "devInit": {
            "tenantCode": "string",
            "projectID": "string",
            "areaID": "string",
            "deptID": "string"
        }
    },
    "customUi": {}
}'

返回响应

🟢200成功

application/json

A successful response.

Body

code

integer

返回code

可选

默认值:

200

msg

string

返回的消息

可选

示例

{
    "code": "200",
    "msg": "string"
}

更新产品自定义信息

删除产品