产品管理 ¶

创建产品 ¶

功能介绍 ¶

调用该接口创建产品。

URI ¶

POST /v1.0/openapi/product

请求参数 ¶

请求Header参数

参数	是否必选	参数类型	描述
x-token	是	String	参数说明：用户Token。通过认证鉴权接口获取用户Token，接口返回的“access_token”就是用户Token。简要的获取方法样例请参见认证鉴权。

请求Body参数

参数	是否必选	参数类型	描述
name	是	String	参数说明：产品名称。
protocol	是	String	参数说明：协议。
node_type	是	String	参数说明：节点类型。
net_type	是	String	参数说明：联网方式。
data_format	是	String	参数说明：上报数据格式。
factory	否	String	参数说明：工厂名称。
description	否	String	参数说明：产品描述。

响应参数 ¶

公共参数

参数	参数类型	描述
success	Bool	参数说明：是否调用成功。
errorCode	Integer	参数说明：调用失败时，返回的错误码，更多信息，请参见状态码。
errorMsg	String	参数说明：调用失败时，返回的出错信息。
result	Object	参数说明：具体结果。

请求示例 ¶

json

curl --location 'http://127.0.0.1:58081/v1.0/openapi/product' \
--header 'x-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiVXNlcm5hbWUiOiJhZG1pbiIsImV4cCI6MTY4ODE5NzM0OSwiaXNzIjoiZWRnZS1nYXRld2F5IiwibmJmIjoxNjcwMDUyMzQ5fQ.NEBjrUrkSabtMuZjo4bzB3rzOT-zZ1YKxILLthFQ2wQ' \
--header 'Content-Type: application/json' \
--data '{
    "name":"断路器",
    "protocol":"MQTT",
    "node_type":"直连设备",
    "net_type":"以太网",
    "data_format":"标准物模型",
    "factory":"工厂名称",
    "description":"产品描述"
}'

响应示例 ¶

json

{
    "success": true,
    "errorCode": 0,
    "errorMsg": "success",
    "result": []
}

查询产品 ¶

功能介绍 ¶

调用该接口查询指定产品的详细信息。

URI ¶

GET /v1.0/openapi/product/{productId}

请求参数 ¶

请求Header参数

参数	是否必选	参数类型	描述
x-token	是	String	参数说明：用户Token。通过认证鉴权接口获取用户Token，接口返回的“access_token”就是用户Token。简要的获取方法样例请参见认证鉴权。

路径参数

参数	是否必选	参数类型	描述
productId	是	String	参数说明：产品ID，用于唯一标识一个产品，在物联网平台创建产品后由平台分配获得。

响应参数 ¶

公共参数

参数	参数类型	描述
success	Bool	参数说明：是否调用成功。
errorCode	Integer	参数说明：调用失败时，返回的错误码，更多信息，请参见状态码。
errorMsg	String	参数说明：调用失败时，返回的出错信息。
result	Object	参数说明：具体结果。

详情

参数	参数类型	描述
id	String	参数说明：产品ID，用于唯一标识一个产品，在物联网平台创建产品后由平台分配获得。
name	String	参数说明：产品名称。
platform	String	参数说明：产品平台。
protocol	String	参数说明：产品协议。
node_type	String	参数说明：产品节点类型。
net_type	String	参数说明：产品联网方式。
status	String	参数说明：产品发布状态。
data_format	String	参数说明：产品数据类型。
factory	String	参数说明：工厂。
description	String	参数说明：描述。
created_at	Integer	参数说明：创建时间。

请求示例 ¶

json

curl --location 'http://127.0.0.1:58081/v1.0/openapi/products/8499371' \
--header 'x-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiVXNlcm5hbWUiOiJhZG1pbiIsImV4cCI6MTY4ODE5NzM0OSwiaXNzIjoiZWRnZS1nYXRld2F5IiwibmJmIjoxNjcwMDUyMzQ5fQ.NEBjrUrkSabtMuZjo4bzB3rzOT-zZ1YKxILLthFQ2wQ' \

响应示例 ¶

json

{
    "success": true,
    "errorCode": 0,
    "errorMsg": "success",
    "result": {
        "id": "8499371",
        "name": "断路器",
        "platform": "本地",
        "protocol": "MQTT",
        "node_type": "直连设备",
        "net_type": "以太网",
        "data_format": "标准物模型",
        "status": "未发布",
        "factory": "工厂名称",
        "description": "产品描述",
        "created_at": 1686563197390
    }
}

产品列表 ¶

功能介绍 ¶

调用该接口查看所有产品列表

URI ¶

GET /v1.0/openapi/products

请求参数 ¶

请求Header参数

参数	是否必选	参数类型	描述
x-token	是	String	参数说明：用户Token。通过认证鉴权接口获取用户Token，接口返回的“access_token”就是用户Token。简要的获取方法样例请参见认证鉴权。

请求Query参数

参数	是否必选	参数类型	描述
name	否	String	参数说明：产品名字，支持模糊搜索。
platform	否	String	参数说明：产品平台。
page	否	Integer	参数说明：第几页（默认1）。
pageSize	否	Integer	参数说明：每页显示的条数（默认10）。

响应参数 ¶

公共参数

参数	参数类型	描述
success	Bool	参数说明：是否调用成功。
errorCode	Integer	参数说明：调用失败时，返回的错误码，更多信息，请参见状态码。
errorMsg	String	参数说明：调用失败时，返回的出错信息。
result	Object	参数说明：具体结果。

详情

参数	参数类型	描述
list	Array	参数说明：产品列表。
list.id	String	参数说明：产品ID，用于唯一标识一个产品，在物联网平台创建产品后由平台分配获得。
list.name	String	参数说明：产品名称。
list.platform	String	参数说明：产品平台。
list.protocol	String	参数说明：产品协议。
list.node_type	String	参数说明：产品节点类型。
list.net_type	String	参数说明：产品联网方式。
list.data_format	String	参数说明：产品数据类型。
list.factory	String	参数说明：工厂。
list.status	String	参数说明：发布状态。
list.description	String	参数说明：描述。
list.created_at	Integer	参数说明：创建时间。
total	Integer	参数说明：产品总数。
page	Integer	参数说明：页面数。
pageSize	Integer	参数说明：每页显示的条数。

请求示例 ¶

json

curl --location 'http://127.0.0.1:58081/v1.0/openapi/products' \
--header 'x-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiVXNlcm5hbWUiOiJhZG1pbiIsImV4cCI6MTY4ODE5NzM0OSwiaXNzIjoiZWRnZS1nYXRld2F5IiwibmJmIjoxNjcwMDUyMzQ5fQ.NEBjrUrkSabtMuZjo4bzB3rzOT-zZ1YKxILLthFQ2wQ' \

响应示例 ¶

json

{
    "success":true,
    "errorCode":0,
    "errorMsg":"success",
    "result":{
        "list":[
            {
                "id":"8499371",
                "name":"断路器",
                "platform":"本地",
                "protocol":"MQTT",
                "node_type":"直连设备",
                "net_type":"以太网",
                "data_format":"标准物模型",
                "status":"发布状态",
                "factory":"工厂名称",
                "description":"产品描述",
                "created_at":1686563197390
            }
        ],
        "total":1,
        "page":1,
        "pageSize":10
    }
}

更新产品 ¶

功能介绍 ¶

调用该接口修改指定产品的信息。

URI ¶

UPDATE /v1.0/openapi/product/{productId}

请求参数 ¶

请求Header参数

参数	是否必选	参数类型	描述
x-token	是	String	参数说明：用户Token。通过认证鉴权接口获取用户Token，接口返回的“access_token”就是用户Token。简要的获取方法样例请参见认证鉴权。

请求Body参数

参数	是否必选	参数类型	描述
name	否	String	参数说明：产品名称。
protocol	否	String	参数说明：产品协议。
node_type	否	String	参数说明：产品的节点类型。支持以下值 `网关子设备` `直连设备` `网关` `其他`
net_type	否	String	参数说明：产品联网方式。支持以下值 `NB` `以太网` `WIFI` `蜂窝` `其他`
data_format	否	String	参数说明：产品数据类型。仅支持 `标准物模型`
factory	否	String	参数说明：产品厂家。
description	否	String	参数说明：产品描述。

响应参数 ¶

公共参数

参数	参数类型	描述
success	Bool	参数说明：是否调用成功。
errorCode	Integer	参数说明：调用失败时，返回的错误码，更多信息，请参见状态码。
errorMsg	String	参数说明：调用失败时，返回的出错信息。
result	Object	参数说明：具体结果。

请求示例 ¶

json

curl --location --request PUT 'http://127.0.0.1:58081/v1.0/openapi/product/3925246' \
--header 'x-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiVXNlcm5hbWUiOiJhZG1pbiIsImV4cCI6MTY4ODE5NzM0OSwiaXNzIjoiZWRnZS1nYXRld2F5IiwibmJmIjoxNjcwMDUyMzQ5fQ.NEBjrUrkSabtMuZjo4bzB3rzOT-zZ1YKxILLthFQ2wQ' \
--header 'Content-Type: application/json' \
--data '{
    "name":"断路器"
}'

响应示例 ¶

json

{
    "success": true,
    "errorCode": 0,
    "errorMsg": "success",
    "result": []
}

发布产品 ¶

功能介绍 ¶

调用该接口发布产品。

URI ¶

POST /v1.0/openapi/product-release/{productId}

请求参数 ¶

请求Header参数

参数	是否必选	参数类型	描述
x-token	是	String	参数说明：用户Token。通过认证鉴权接口获取用户Token，接口返回的“access_token”就是用户Token。简要的获取方法样例请参见认证鉴权。

路径参数

参数	是否必选	参数类型	描述
productId	是	String	参数说明：产品ID，用于唯一标识一个产品，在物联网平台创建产品后由平台分配获得。

响应参数 ¶

公共参数

参数	参数类型	描述
success	Bool	参数说明：是否调用成功。
errorCode	Integer	参数说明：调用失败时，返回的错误码，更多信息，请参见状态码。
errorMsg	String	参数说明：调用失败时，返回的出错信息。
result	Object	参数说明：具体结果。

请求示例 ¶

json

curl --location --request POST 'http://127.0.0.1:58081/v1.0/openapi/product-release/6476854' \
--header 'x-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiVXNlcm5hbWUiOiJhZG1pbiIsImV4cCI6MTY5MDU0NjE1MiwiaXNzIjoiZWRnZS1nYXRld2F5IiwibmJmIjoxNjkwMjg1OTUyfQ.sCmRocJUOgPh_emhA1fR70e5c2HdtiHswYBl9FOno3w'

响应示例 ¶

json

{
    "success": true,
    "errorCode": 0,
    "errorMsg": "success",
    "result": []
}

取消发布产品 ¶

功能介绍 ¶

调用该接口取消发布产品。

URI ¶

POST /v1.0/openapi/product-unrelease/{productId}

请求参数 ¶

请求Header参数

参数	是否必选	参数类型	描述
x-token	是	String	参数说明：用户Token。通过认证鉴权接口获取用户Token，接口返回的“access_token”就是用户Token。简要的获取方法样例请参见认证鉴权。

路径参数

参数	是否必选	参数类型	描述
productId	是	String	参数说明：产品ID，用于唯一标识一个产品，在物联网平台创建产品后由平台分配获得。

响应参数 ¶

公共参数

参数	参数类型	描述
success	Bool	参数说明：是否调用成功。
errorCode	Integer	参数说明：调用失败时，返回的错误码，更多信息，请参见状态码。
errorMsg	String	参数说明：调用失败时，返回的出错信息。
result	Object	参数说明：具体结果。

请求示例 ¶

json

curl --location --request POST 'http://127.0.0.1:58081/v1.0/openapi/product-unrelease/6476854' \
--header 'x-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiVXNlcm5hbWUiOiJhZG1pbiIsImV4cCI6MTY5MDU0NjE1MiwiaXNzIjoiZWRnZS1nYXRld2F5IiwibmJmIjoxNjkwMjg1OTUyfQ.sCmRocJUOgPh_emhA1fR70e5c2HdtiHswYBl9FOno3w'

响应示例 ¶

json

{
    "success": true,
    "errorCode": 0,
    "errorMsg": "success",
    "result": []
}

删除产品 ¶

功能介绍 ¶

调用该接口删除指定产品。

URI ¶

DELETE /v1.0/openapi/product/{productId}

请求参数 ¶

请求Header参数

参数	是否必选	参数类型	描述
x-token	是	String	参数说明：用户Token。通过认证鉴权接口获取用户Token，接口返回的“access_token”就是用户Token。简要的获取方法样例请参见认证鉴权。

路径参数

参数	是否必选	参数类型	描述
productId	是	String	参数说明：产品ID，用于唯一标识一个产品，在物联网平台创建产品后由平台分配获得。

响应参数 ¶

公共参数

参数	参数类型	描述
success	Bool	参数说明：是否调用成功。
errorCode	Integer	参数说明：调用失败时，返回的错误码，更多信息，请参见状态码。
errorMsg	String	参数说明：调用失败时，返回的出错信息。
result	Object	参数说明：具体结果。

请求示例 ¶

json

curl --location --request DELETE 'http://127.0.0.1:58081/v1.0/openapi/product/3048451' \
--header 'x-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiVXNlcm5hbWUiOiJhZG1pbiIsImV4cCI6MTY3MDU1NTQ4OCwiaXNzIjoiZWRnZS1nYXRld2F5IiwibmJmIjoxNjY5OTQ5Njg4fQ.XoIDb3pM0wcb1CxXknHEU82Df4zCvAvoptX57RIvsN8'

响应示例 ¶

json

{
    "success": true,
    "errorCode": 0,
    "errorMsg": "success",
    "result": []
}

函数

产品管理 ¶

创建产品 ¶

功能介绍 ¶

URI ¶

请求参数 ¶

响应参数 ¶

请求示例 ¶

响应示例 ¶

查询产品 ¶

功能介绍 ¶

URI ¶

请求参数 ¶

响应参数 ¶

请求示例 ¶

响应示例 ¶

产品列表 ¶

功能介绍 ¶

URI ¶

请求参数 ¶

响应参数 ¶

请求示例 ¶

响应示例 ¶

更新产品 ¶

功能介绍 ¶

URI ¶

请求参数 ¶

响应参数 ¶

请求示例 ¶

响应示例 ¶

发布产品 ¶

功能介绍 ¶

URI ¶

请求参数 ¶

响应参数 ¶

请求示例 ¶

响应示例 ¶

取消发布产品 ¶

功能介绍 ¶

URI ¶

请求参数 ¶

响应参数 ¶

请求示例 ¶

响应示例 ¶

删除产品 ¶

功能介绍 ¶

URI ¶

请求参数 ¶

响应参数 ¶

请求示例 ¶

响应示例 ¶