产品基本服务
更新时间:2018-03-15 20:34:06
查询产品详情
定义描述
path |
版本 |
描述 |
是否需要登陆 |
/thing/detailInfo/queryProductInfo |
1.1.1 |
查询产品详情,包括模组 |
否 |
请求参数
参数 |
类型 |
必填 |
描述 |
iotId |
String |
是 |
iotId |
返回参数
参数 |
类型 |
描述 |
tenantId |
Long |
租户id |
productKey |
String |
产品PK |
dataFormat |
String |
数据格式 |
netType |
String |
入网类型 |
productSecret |
String |
产品密钥 |
nodeType |
String |
节点类型 |
domain |
String |
领域 |
name |
String |
产品名称 |
region |
String |
地域 |
ownerDomain |
String |
所有者领域 |
categoryId |
Long |
归属品类id |
accessMethod |
String |
访问方式 |
status |
Integer |
产品状态(0:开发中,1:已发布) |
gmtCreate |
Date |
创建时间 |
gmtModified |
Date |
修改时间 |
creator |
String |
创建者 |
modifier |
String |
修改者 |
productId |
Long |
产品Id |
aliyunCommodityCode |
String |
商品码 |
connectMode |
String |
配网方式 |
rbacTenantId |
String |
rbac租户Id |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request": {
"apiVer": "1.0.0",
"iotToken": "token"
},
"params": {
"iotId": "D95D242941CE821ECCE4F31A2697"
}
}
正常返回示例
{
"code": 200,
"data": {
"accessMethod": "DATA_DIRECT",
"gmtModified": 1517217645000,
"modifier": "5030ala9cd2091d851a80fbdc63b454243668090",
"productKey": "a1I0TQKlMCW",
"creator": "5030ala9cd2091d851a80fbdc63b454243668090",
"productId": 87634,
"dataFormat": "ALINK_FORMAT",
"netType": "NET_WIFI",
"aliyunCommodityCode": "tmp",
"productSecret": "tfbMocigfRPqPKKj",
"nodeType": "DEVICE",
"gmtCreate": 1517208303000,
"domain": "a1I0TQKlMCW",
"name": "风扇",
"tenantId": 3312,
"connectMode": "2,3",
"region": "cn-shanghai",
"ownerDomain": "tmp_5030ala9cd2091d851a80fbdc63b454243668090",
"rbacTenantId": "755ED7C7810B4255BA026BBC48BF0247",
"categoryId": 285,
"status": "RELEASE_STATUS"
},
"id": "6aad0b12-2192-4b90-8f40-08a2bc0b5c2a"
}
错误码
错误码 |
错误信息 |
详细描述 |
5225 |
query product failed |
查询产品失败 |
5005 |
product not found |
产品没有找到 |
根据产品Key查询产品详情
定义描述
path |
版本 |
描述 |
是否需要登陆 |
/thing/detailInfo/queryProductInfoByProductKey |
1.1.1 |
根据产品Key查询产品信息 |
否 |
请求参数
参数 |
类型 |
必填 |
描述 |
productKey |
String |
是 |
产品Key |
返回参数
参数 |
类型 |
描述 |
tenantId |
Long |
租户id |
productKey |
String |
产品PK |
dataFormat |
String |
数据格式 |
netType |
String |
入网类型 |
productSecret |
String |
产品密钥 |
nodeType |
String |
节点类型 |
domain |
String |
领域 |
name |
String |
产品名称 |
region |
String |
地域 |
ownerDomain |
String |
所有者领域 |
categoryId |
Long |
归属品类id |
accessMethod |
String |
访问方式 |
status |
Integer |
产品状态(0:开发中,1:已发布) |
gmtCreate |
Date |
创建时间 |
gmtModified |
Date |
修改时间 |
creator |
String |
创建者 |
modifier |
String |
修改者 |
productId |
Long |
产品Id |
aliyunCommodityCode |
String |
商品码 |
connectMode |
String |
配网方式 |
rbacTenantId |
String |
rbac租户Id |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request": {
"apiVer": "1.0.0",
"iotToken": "token"
},
"params": {
"productKey": "a1eaZKTdVAH"
}
}
正常返回示例
{
"code": 200,
"data": {
"accessMethod": "DATA_DIRECT",
"gmtModified": 1517217645000,
"modifier": "5030ala9cd2091d851a80fbdc63b454243668090",
"productKey": "a1I0TQKlMCW",
"creator": "5030ala9cd2091d851a80fbdc63b454243668090",
"productId": 87634,
"dataFormat": "ALINK_FORMAT",
"netType": "NET_WIFI",
"aliyunCommodityCode": "tmp",
"productSecret": "tfbMocigfRPqPKKj",
"nodeType": "DEVICE",
"gmtCreate": 1517208303000,
"domain": "a1I0TQKlMCW",
"name": "风扇",
"tenantId": 3312,
"connectMode": "2,3",
"region": "cn-shanghai",
"ownerDomain": "tmp_5030ala9cd2091d851a80fbdc63b454243668090",
"rbacTenantId": "755ED7C7810B4255BA026BBC48BF0247",
"categoryId": 285,
"status": "RELEASE_STATUS"
},
"id": "6aad0b12-2192-4b90-8f40-08a2bc0b5c2a"
}
错误码
错误码 |
错误信息 |
详细描述 |
5225 |
query product failed |
查询产品失败 |
5005 |
product not found |
产品没有找到 |
根据品类Id查询产品列表
定义描述
path |
版本 |
描述 |
是否需要登陆 |
/thing/productInfo/getByCategory |
1.1.1 |
根据品类查询租户创建的所有产品 |
否 |
请求参数
参数 |
类型 |
必填 |
描述 |
categoryId |
Long |
是 |
品类Id |
返回参数
参数 |
类型 |
描述 |
tenantId |
Long |
租户id |
productKey |
String |
产品PK |
dataFormat |
String |
数据格式 |
netType |
String |
入网类型 |
productSecret |
String |
产品密钥 |
nodeType |
String |
节点类型 |
domain |
String |
领域 |
name |
String |
产品名称 |
region |
String |
地域 |
ownerDomain |
String |
所有者领域 |
categoryId |
Long |
归属品类id |
accessMethod |
String |
访问方式 |
status |
Integer |
产品状态(0:开发中,1:已发布) |
gmtCreate |
Date |
创建时间 |
gmtModified |
Date |
修改时间 |
creator |
String |
创建者 |
modifier |
String |
修改者 |
productId |
Long |
产品Id |
aliyunCommodityCode |
String |
商品码 |
connectMode |
String |
配网方式 |
rbacTenantId |
String |
rbac租户Id |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request": {
"apiVer": "1.0.0",
"iotToken": "token"
},
"params": {
"categoryId": 12
}
}
正常返回示例
{
"code": 200,
"data": [{
"accessMethod": "DATA_DIRECT",
"gmtModified": 1517562992000,
"productModel": "niki_test_prodcut_model",
"modifier": "50a1al5842f9067bd97f3350201b3f85e2ff9014",
"productKey": "a15iEO9rxCf",
"image": "logo",
"creator": "50a1al5842f9067bd97f3350201b3f85e2ff9014",
"productId": 95959,
"dataFormat": "CUSTOM_FORMAT",
"netType": "NET_CELLULAR",
"aliyunCommodityCode": "tmp",
"productSecret": "Y1kNXdpAuoHICkCw",
"nodeType": "DEVICE",
"gmtCreate": 1517562992000,
"domain": "a15iEO9rxCf",
"name": "test_name",
"tenantId": 21,
"region": "cn-hangzhou",
"rbacTenantId": "2BF8238E359B4C84A9859C7180BD2CF6",
"ownerDomain": "tmp_50a1al5842f9067bd97f3350201b3f85e2ff9014",
"categoryId": 61,
"status": "DEVELOPMENT_STATUS"
}],
"id": "db13e9ae-c617-4f50-b792-a1e4f43e36ec"
}
错误码
错误码 |
错误信息 |
详细描述 |
5225 |
query product failed |
查询产品失败 |
5005 |
product not found |
产品没有找到 |
查询配网信息
定义描述
path |
版本 |
描述 |
是否需要登陆 |
/awss/enrollee/guide/get |
1.1.1 |
查询配网引导 |
否 |
请求参数
参数 |
类型 |
必填 |
描述 |
productKey |
String |
是 |
productKey |
返回参数
参数 |
类型 |
描述 |
productKey |
String |
产品Key |
helpTitle |
String |
帮助标题 |
dnGuideIcon |
String |
配网引导图标 |
helpCopywriting |
String |
帮助文案 |
buttonCopywriting |
String |
按钮文案 |
dnCopywriting |
String |
配网文案 |
helpIcon |
String |
帮助图标 |
id |
Long |
配网引导id |
gmtCreate |
Date |
创建时间 |
gmtModified |
Date |
修改时间 |
creator |
String |
创建者 |
modifier |
String |
修改者 |
rbacTenantId |
String |
rbac租户Id |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request": {
"apiVer": "1.0.0",
"iotToken": "token"
},
"params": {
"productKey": "a1eaZKTdVAH"
}
}
正常返回示例
{
"code": 200,
"data": [{
"gmtModified": 1517476367000,
"creator": "755ED7C7810B4255BA026BBC48BF0247",
"helpTitle": "指示灯没有闪烁?",
"dnGuideIcon": "http://iotx-ilop.oss-cn-hangzhou.aliyuncs.com/iotx-ilop-portal/p/a124FzVD7BCP4Qfi/networkConfig/1517476344732/timg.jpg",
"helpCopywriting": "请长按重置3-5秒,确保看到指示灯闪烁后松开",
"modifier": "755ED7C7810B4255BA026BBC48BF0247",
"buttonCopywriting": "我确认在闪烁",
"gmtCreate": 1517476347000,
"productKey": "a1I0TQKlMCW",
"id": 87,
"dnCopywriting": "接通电源,确认指示灯闪烁",
"helpIcon": "http://iotx-ilop.oss-cn-hangzhou.aliyuncs.com/iotx-ilop-portal/p/a124FzVD7BCP4Qfi/networkConfig/1517476333895/timg (1).jpg",
"rbacTenantId": "755ED7C7810B4255BA026BBC48BF0247"
}],
"id": "e6d8bd5e-b79b-475c-b3b8-b3f9c65cdd2b"
}
错误码
错误码 |
错误信息 |
详细描述 |
5005 |
product not found |
产品没有找到 |
获取支持配网的产品列表
定义描述
path |
版本 |
描述 |
是否需要登陆 |
/thing/productInfo/getByAppKey |
1.1.1 |
获取当前支持配网操作的产品列表 |
否 |
请求参数
返回参数
参数 |
类型 |
描述 |
tenantId |
String |
租户id |
productKey |
String |
产品PK |
dataFormat |
Integer |
数据格式(0:透传/自定义格式,1:Alink协议) |
netType |
Integer |
入网类型(0:LORA,3:WIFI,4:ZIGBEE,5:BT,6:CELLULAR,7:ETHERNET,8:NET_OTHER) |
productSecret |
String |
产品密钥 |
nodeType |
Integer |
节点类型(0:DEVICE,1:GATEWAY) |
domain |
String |
领域 |
name |
String |
产品名称 |
region |
String |
地域 |
ownerDomain |
String |
所有者领域 |
categoryId |
Long |
归属品类id |
accessMethod |
Integer |
访问方式(0: 数据直连,1: 空中转发,2: APP) |
status |
Integer |
产品状态(0:开发中,1:已发布) |
gmtCreate |
Date |
创建时间 |
gmtModified |
Date |
修改时间 |
description |
String |
产品描述 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request": {
"apiVer": "1.0.0",
"iotToken": "token"
},
"params": {
}
}
正常返回示例
{
"id": "94e0871c-0770-4bb3-9e29-e840d86b3ba6",
"code": 200,
"data":[
{
"accessMethod": 0,
"gmtModified": 1515829586000,
"productKey": "a1oOl0IW16u",
"dataFormat": 1,
"netType": 3,
"productSecret": "ltlcLETSZpP4z16x",
"nodeType": 0,
"gmtCreate": 1515829586000,
"domain": "a1oOl0IW16u",
"name": "灯",
"tenantId": "D99AEB09DCDB4B25ACF008B2DCE1E313",
"region": "cn-shanghai",
"ownerDomain": "tmp_501dal8bad0cd19692ec25122e20ade36a8f0943",
"categoryId": 278,
"status": 0
}
]
}
错误码