提供一組與產(chǎn)品相關(guān)的服務(wù)接口，客戶(hù)端應(yīng)用通過(guò)本組服務(wù)接口可以實(shí)現(xiàn)產(chǎn)品信息的查詢(xún)，包括可配網(wǎng)產(chǎn)品列表、配網(wǎng)引導(dǎo)頁(yè)信息以及具體產(chǎn)品信息的查詢(xún)。

根據(jù)設(shè)備ID查詢(xún)產(chǎn)品詳情

定義描述

path 版本 描述 是否需要登錄
/thing/detailInfo/queryProductInfo 1.1.3 查詢(xún)產(chǎn)品詳情信息 否

請(qǐng)求參數(shù)

參數(shù) 類(lèi)型 必填 描述
iotId String 是 設(shè)備ID

返回參數(shù)

參數(shù) 類(lèi)型 必有 描述
productKey String 是 產(chǎn)品的Key
dataFormat String 是 數(shù)據(jù)格式
  • CUSTOM_FORMAT：透?jìng)?自定義格式
  • ALINK_FORMAT：Alink協(xié)議
netType String 是 設(shè)備入網(wǎng)類(lèi)型：
  • lora：NET_LORA
  • gprs：NET_CELLULAR
  • wifi：NET_WIFI
  • zigbee：NET_ZIGBEE
  • 藍(lán)牙：NET_BT
  • 以太網(wǎng)：NET_ETHERNET
  • 其他：NET_OTHER
productSecret String 否 產(chǎn)品密鑰
nodeType String 是 設(shè)備的節(jié)點(diǎn)類(lèi)型：DEVICE，GATEWAY
domain String 否 產(chǎn)品域
name String 是 產(chǎn)品名稱(chēng)
region String 是 地域
ownerDomain String 否 所有者領(lǐng)域
categoryId Long 是 歸屬品類(lèi)ID
categoryKey String 否 品類(lèi)標(biāo)識(shí)符
categoryName String 否 品類(lèi)名稱(chēng)
accessMethod String 是 訪問(wèn)方式
  • DATA_DIRECT：數(shù)據(jù)直連
  • AIR_FORWARD：空中轉(zhuǎn)發(fā)
  • APP：APP
  • VIRTUAL：虛擬設(shè)備
status String 是 產(chǎn)品狀態(tài)
  • DEVELOPMENT_STATUS：開(kāi)發(fā)中
  • RELEASE_STATUS：已發(fā)布
gmtCreate Date 是 創(chuàng)建時(shí)間
gmtModified Date 是 修改時(shí)間
creator String 是 創(chuàng)建者
modifier String 是 修改者
productId Long 是 產(chǎn)品ID
aliyunCommodityCode String 否 商品碼
connectMode String 是 配網(wǎng)方式
rbacTenantId String 是 租戶(hù)ID

示例

  • 請(qǐng)求示例 
    {
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.1.3",
        "iotToken": "token"
    },
    "params": {
        "iotId": "D95D2429xxxxxxxxF31A2697"
    }
}
  • 正常返回示例 
    {
    "code": 200,
    "data": {
        "accessMethod": "DATA_DIRECT",
        "gmtModified": 1517217645000,
        "modifier": "5030ala9cd20xxxxxxxxc63b454243668090",
        "productKey": "a1IxxxxW",
        "creator": "5030ala9cdxxxxxxxxc63b454243668090",
        "productId": 87634,
        "dataFormat": "ALINK_FORMAT",
        "netType": "NET_WIFI",
        "aliyunCommodityCode": "tmp",
        "productSecret": "tfbMxxxxKKj",
        "nodeType": "DEVICE",
        "gmtCreate": 1517208303000,
        "domain": "a1IxxxxCW",
        "name": "風(fēng)扇",
        "tenantId": 3312,
        "connectMode": "2,3",
        "region": "cn-shanghai",
        "ownerDomain": "tmp_5030alxxxxxxxx0fbdc63b454243668090",
        "rbacTenantId": "755ED7C7xxxxxxxx026BBC48BF0247",
        "categoryId": 285,
        "status": "RELEASE_STATUS"
    },
    "id": "6aad0b12-2192-xxxx-xxxx-08a2bc0b5c2a"
}

根據(jù)產(chǎn)品key查詢(xún)產(chǎn)品詳情

定義描述

path 版本 描述 是否需要登錄
/thing/allProductInfo/getByProductKey 1.1.3 根據(jù)ProductKey查詢(xún)產(chǎn)品信息 否

請(qǐng)求參數(shù)

參數(shù) 類(lèi)型 必填 描述
productkey String 是 產(chǎn)品Key

返回參數(shù)

參數(shù) 類(lèi)型 必有 描述
productKey String 是 產(chǎn)品的Key
dataFormat String 是 數(shù)據(jù)格式
  • CUSTOM_FORMAT：透?jìng)?自定義格式
  • ALINK_FORMAT：Alink協(xié)議
netType String 是 設(shè)備入網(wǎng)類(lèi)型：
  • lora：NET_LORA
  • gprs：NET_CELLULAR
  • wifi：NET_WIFI
  • zigbee：NET_ZIGBEE
  • 藍(lán)牙：NET_BT
  • 以太網(wǎng)：NET_ETHERNET
  • 其他：NET_OTHER
productSecret String 否 產(chǎn)品密鑰
nodeType String 是 節(jié)點(diǎn)類(lèi)型，DEVICE：設(shè)備；GATEWAY：網(wǎng)關(guān)
domain String 否 產(chǎn)品域
name String 是 產(chǎn)品名稱(chēng)
region String 是 地域
ownerDomain String 否 所有者領(lǐng)域
categoryId Long 是 歸屬品類(lèi)ID
categoryKey String 否 品類(lèi)標(biāo)識(shí)符
categoryName String 否 品類(lèi)名稱(chēng)
accessMethod String 是 訪問(wèn)方式
  • DATA_DIRECT：數(shù)據(jù)直連
  • AIR_FORWARD：空中轉(zhuǎn)發(fā)
  • APP：APP
  • VIRTUAL：虛擬設(shè)備
status String 是 產(chǎn)品狀態(tài)
  • DEVELOPMENT_STATUS：開(kāi)發(fā)中
  • RELEASE_STATUS：已發(fā)布
gmtCreate Date 是 創(chuàng)建時(shí)間
gmtModified Date 是 修改時(shí)間
creator String 是 創(chuàng)建者
modifier String 是 修改者
productId Long 是 產(chǎn)品ID
aliyunCommodityCode String 否 商品碼
connectMode String 是 配網(wǎng)方式
rbacTenantId String 是 rbac租戶(hù)ID

示例

  • 請(qǐng)求示例 
    {
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.1.3",
        "iotToken": "token"
    },
    "params": {
        "productKey": "a1xxxxVAH"
    }
}
  • 正常返回示例 
    {
    "code": 200,
    "data": {
        "accessMethod": "DATA_DIRECT",
        "gmtModified": 1517217645000,
        "modifier": "5030alxxxxxxxxfbdc63b454243668090",
        "productKey": "a1IxxxxCW",
        "creator": "5030ala9cdxxxxxxxxc63b454243668090",
        "productId": 87634,
        "dataFormat": "ALINK_FORMAT",
        "netType": "NET_WIFI",
        "aliyunCommodityCode": "tmp",
        "productSecret": "tfbxxxxxxxxqPKKj",
        "nodeType": "DEVICE",
        "gmtCreate": 1517208303000,
        "domain": "a1I0TQKlMCW",
        "name": "風(fēng)扇",
        "tenantId": 3312,
        "connectMode": "2,3",
        "region": "cn-shanghai",
        "ownerDomain": "tmp_5030ala9cdxxxxxxxxb454243668090",
        "rbacTenantId": "755ED7Cxxxxxxxx26BBC48BF0247",
        "categoryId": 285,
        "status": "RELEASE_STATUS"
    },
    "id": "6aad0b12-2192-xxxx-xxxx-08a2bc0b5c2a"
}

根據(jù)品類(lèi)ID查詢(xún)產(chǎn)品列表

定義描述

path 版本 描述 是否需要登錄
/thing/productInfo/getByCategory 1.1.4 根據(jù)品類(lèi)查詢(xún)租戶(hù)創(chuàng)建的所有產(chǎn)品，無(wú)需租戶(hù)ID 否

請(qǐng)求參數(shù)

參數(shù) 類(lèi)型 必填 描述
categoryId Long 是 品類(lèi)ID
rbacTenantId String 否 rbac租戶(hù)ID

返回參數(shù)

參數(shù) 類(lèi)型 必有 描述
productKey String 是 產(chǎn)品的Key
dataFormat String 是 數(shù)據(jù)格式：0-透?jìng)?自定義格式；1-Alink協(xié)議
netType String 是 入網(wǎng)類(lèi)型：0-LORA；3-WIFI；4-:ZIGBEE；5-BT；6-CELLULAR；7-ETHERNET；8-NET_OTHER
productSecret String 否 產(chǎn)品密鑰
nodeType String 是 節(jié)點(diǎn)類(lèi)型：0-DEVICE；1-GATEWAY
domain String 否 產(chǎn)品域
name String 是 產(chǎn)品名稱(chēng)
region String 是 地域
ownerDomain String 否 所有者領(lǐng)域
categoryId Long 是 歸屬品類(lèi)ID
categoryKey String 否 品類(lèi)標(biāo)識(shí)符
categoryName String 否 品類(lèi)名稱(chēng)
accessMethod String 是 訪問(wèn)方式：0-數(shù)據(jù)直連；1-空中轉(zhuǎn)發(fā)；2-APP
status Integer 是 產(chǎn)品狀態(tài)：0-開(kāi)發(fā)中；1-已發(fā)布
gmtCreate Date 是 創(chuàng)建時(shí)間
gmtModified Date 是 修改時(shí)間
creator String 是 創(chuàng)建者
modifier String 是 修改者
productId Long 是 產(chǎn)品ID
aliyunCommodityCode String 否 商品碼
connectMode String 是 配網(wǎng)方式
rbacTenantId String 是 租戶(hù)ID

示例

  • 請(qǐng)求示例 
    {
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.1.3",
        "iotToken": "token"
    },
    "params": {
        "categoryId": 12
    }
}
  • 正常返回示例 
    {
    "code": 200,
    "data": [{
        "accessMethod": "DATA_DIRECT",
        "gmtModified": 1517562992000,
        "productModel": "niki_test_prodcut_model",
        "modifier": "50a1al58xxxxxxxx201b3f85e2ff9014",
        "productKey": "a1xxxxCf",
        "image": "logo",
        "creator": "50a1alxxxx201b3f85e2ff9014",
        "productId": 95959,
        "dataFormat": "CUSTOM_FORMAT",
        "netType": "NET_CELLULAR",
        "aliyunCommodityCode": "tmp",
        "productSecret": "Y1kxxxxxxxxkCw",
        "nodeType": "DEVICE",
        "gmtCreate": 1517562992000,
        "domain": "a15iEO9rxCf",
        "name": "test_name",
        "tenantId": 21,
        "region": "cn-hangzhou",
        "rbacTenantId": "2BF8238E3xxxxxxxx9C7180BD2CF6",
        "ownerDomain": "tmp_50a1al5xxxxxxxxf3350201b3f85e2ff9014",
        "categoryId": 61,
        "status": "DEVELOPMENT_STATUS"
    }],
    "id": "db13e9ae-c617-xxxx-xxxx-a1e4f43e36ec"
}

查詢(xún)配網(wǎng)引導(dǎo)信息

定義描述

path 版本 描述 是否需要用戶(hù)身份的鑒權(quán)
/awss/enrollee/guide/get 1.1.3 查詢(xún)配網(wǎng)引導(dǎo)頁(yè)的模版定義信息，用于客戶(hù)端展示友好的配網(wǎng)流程的引導(dǎo)信息 是，客戶(hù)端SDK需啟用身份的鑒權(quán)，進(jìn)行身份認(rèn)證

請(qǐng)求參數(shù)

參數(shù) 類(lèi)型 必填 描述
productKey String 是 productKey

返回參數(shù)

參數(shù) 類(lèi)型 必有 描述
productKey String 是 產(chǎn)品Key
helpTitle String 否 幫助標(biāo)題
dnGuideIcon String 否 配網(wǎng)引導(dǎo)圖標(biāo)
helpCopywriting String 否 幫助文案
buttonCopywriting String 否 按鈕文案
dnCopywriting String 否 配網(wǎng)文案
helpIcon String 否 幫助圖標(biāo)
id Long 是 配網(wǎng)引導(dǎo)ID
gmtCreate Date 是 創(chuàng)建時(shí)間
gmtModified Date 是 修改時(shí)間
creator String 是 創(chuàng)建者
modifier String 是 修改者
rbacTenantId String 是 rbac租戶(hù)ID

示例

  • 請(qǐng)求示例 
    {
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.1.3",
        "iotToken": "token"
    },
    "params": {
        "productKey": "a1xxxxAH"
    }
}
  • 正常返回示例 
    {
    "code": 200,
    "data": [{
        "gmtModified": 1517476367000,
        "creator": "755ED7CxxxxxxxxC48BF0247",
        "helpTitle": "指示燈沒(méi)有閃爍？",
        "dnGuideIcon": "http://iotx-ilop.oss-cn-hangzhou.aliyuncs.com/iotx-ilop-portal/p/a12xxxxQfi/networkConfig/1517476344732/timg.jpg",
        "helpCopywriting": "請(qǐng)長(zhǎng)按重置3-5秒，確保看到指示燈閃爍后松開(kāi)",
        "modifier": "755ED7CxxxxxxxxBC48BF0247",
        "buttonCopywriting": "我確認(rèn)在閃爍",
        "gmtCreate": 1517476347000,
        "productKey": "a1xxxxW",
        "id": 87,
        "dnCopywriting": "接通電源，確認(rèn)指示燈閃爍",
        "helpIcon": "http://iotx-ilop.oss-cn-hangzhou.aliyuncs.com/iotx-ilop-portal/p/a12xxxxfi/networkConfig/1517476333895/timg (1).jpg",
        "rbacTenantId": "755ED7C7810B4255BA026BBC48BF0247"
    }],
    "id": "e6d8bd5e-b79b-xxxx-xxxx-b3f9c65cdd2b"
}

獲取支持配網(wǎng)的產(chǎn)品列表

定義描述

path 版本 描述 是否需要登錄
/thing/productInfo/getByAppKey 1.1.5 獲取當(dāng)前支持配網(wǎng)操作的產(chǎn)品列表 是

請(qǐng)求參數(shù)

無(wú)

返回參數(shù)

參數(shù) 類(lèi)型 必有 描述
tenantId String 是 租戶(hù)ID
productKey String 是 產(chǎn)品的Key
dataFormat Integer 是 設(shè)備上傳的數(shù)據(jù)格式，0表示透?jìng)骰蜃远x格式；1表示使用Alink協(xié)議數(shù)據(jù)格式
netType Integer 是 產(chǎn)品入網(wǎng)類(lèi)型：0表示LoRa；3表示W(wǎng)iFi；4表示ZigBee；5表示Bluetooth；6表示蜂窩網(wǎng)；7表示以太網(wǎng)；8表示其他入網(wǎng)方式
nodeType Integer 是 節(jié)點(diǎn)類(lèi)型，0表示設(shè)備；1表示網(wǎng)關(guān)
name String 是 產(chǎn)品名稱(chēng)
region String 是 產(chǎn)品所在地域
categoryKey String 是 產(chǎn)品所屬品類(lèi)的品類(lèi)標(biāo)識(shí)符
categoryName String 是 產(chǎn)品所屬品類(lèi)的名稱(chēng)
accessMethod Integer 是 訪問(wèn)方式：0表示數(shù)據(jù)直連；1表示空中轉(zhuǎn)發(fā)；2表示APP
status Integer 是 產(chǎn)品狀態(tài)，0表示開(kāi)發(fā)中；1表示已發(fā)布
gmtCreate Date 是 產(chǎn)品創(chuàng)建時(shí)間
gmtModified Date 是 上一次產(chǎn)品信息變更的時(shí)間
description String 否 產(chǎn)品描述

示例

  • 請(qǐng)求示例 
    {
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.1.5",
        "iotToken": "token"
    },
    "params": {
    }
}
  • 正常返回示例 
    {
    "id": "94e0871c-0770-xxxx-xxxx-e840d86b3ba6",
    "code": 200,
    "data":[
        {
            "accessMethod": 0,
            "gmtModified": 1515829586000,
            "productKey": "a1oOl0IW16u",
            "dataFormat": 1,
            "netType": 3,
            "nodeType": 0,
            "gmtCreate": 1515829586000,
            "name": "燈",
            "tenantId": "D99AEBxxxxxxxxCF008B2DCE1E313",
            "region": "cn-shanghai",
            "categoryKey":"Light",
            "categoryName":"燈"
            "status": 0
        }
    ]
}