提供了一組與物的產(chǎn)品相關(guān)的服務(wù)接口，云端應(yīng)用通過(guò)本組服務(wù)接口可以實(shí)現(xiàn)對(duì)物的產(chǎn)品列表及物的產(chǎn)品查詢。

查詢項(xiàng)目下的產(chǎn)品列表

定義描述

path 版本 描述 是否需要cloudToken
/cloud/thing/productList/get 1.1.0 查詢當(dāng)前項(xiàng)目下的產(chǎn)品列表 是

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

參數(shù) 類(lèi)型 必填 描述
pageNo int 是 分頁(yè)查詢頁(yè)，從1開(kāi)始
pageSize int 是 分頁(yè)大小

返回參數(shù)

參數(shù) 類(lèi)型 描述
productKey String 產(chǎn)品的Key
dataFormat String 數(shù)據(jù)格式
netType String 入網(wǎng)類(lèi)型
productSecret String 產(chǎn)品密鑰
nodeType String 節(jié)點(diǎn)類(lèi)型
name String 產(chǎn)品名稱
region String 地域
categoryId Long 歸屬品類(lèi)ID
status Integer 產(chǎn)品狀態(tài)
  • 0：開(kāi)發(fā)中
  • 1：已發(fā)布
gmtCreate Date 創(chuàng)建時(shí)間
gmtModified Date 修改時(shí)間
productId Long 產(chǎn)品ID
rbacTenantId String 租戶ID

示例

  • 請(qǐng)求示例 
    {
    "id": 1508232047194,
    "request": {
        "cloudToken": "109049c80xxxxxxxx6f62e29a3ba",
        "apiVer": "1.1.0"
    },
    "params": {
        "pageNo" : 1,
        "pageSize" : 10 
    },
    "version": "1.0"
}
  • 正常返回示例 
    {
    "code": 200,
    "data": [{
        "gmtModified": 1517562992000,
        "productModel": "niki_test_prodcut_model",
        "productKey": "a1xxxxCf",
        "image": "logo",
        "productId": 95959,
        "dataFormat": "CUSTOM_FORMAT",
        "netType": "NET_CELLULAR",
        "productSecret": "Y1kxxxxCw",
        "nodeType": "DEVICE",
        "gmtCreate": 1517562992000,
        "name": "test_name",
        "region": "cn-hangzhou",
        "rbacTenantId": "2BF8238E359xxxxxxxx9C7180CF6",
        "categoryId": 61,
        "status": "DEVELOPMENT_STATUS"
    }],
    "id": "db13e9ae-c617-xxxx-xxxx-a1e4f43e36ec"
}

查詢單個(gè)產(chǎn)品

定義描述

path 版本 描述 是否需要cloudToken
/cloud/thing/product/get 1.1.0 查詢指定產(chǎn)品的詳細(xì)信息 是

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

參數(shù) 類(lèi)型 必填 描述
productKey String 是 物的產(chǎn)品key

返回參數(shù)

參數(shù) 類(lèi)型 描述
productKey String 產(chǎn)品的Key
dataFormat String 數(shù)據(jù)格式
netType String 入網(wǎng)類(lèi)型
productSecret String 產(chǎn)品密鑰
nodeType String 節(jié)點(diǎn)類(lèi)型
name String 產(chǎn)品名稱
region String 地域
categoryId Long 歸屬品類(lèi)ID
status Integer 產(chǎn)品狀態(tài)
  • 0：開(kāi)發(fā)中
  • 1：已發(fā)布
gmtCreate Date 創(chuàng)建時(shí)間
gmtModified Date 修改時(shí)間
productId Long 產(chǎn)品ID
rbacTenantId String 租戶ID

示例

  • 請(qǐng)求示例 
    {
    "id": 1508232047194,
    "request": {
        "cloudToken": "109049c8xxxxxxxxf6f62e29a3ba",
        "apiVer": "1.1.0"
    },
    "params": {
        "productKey": "a1dxxxxkl"
    },
    "version": "1.0"
}
  • 正常返回示例 
    {
    "code": 200,
    "data": {
        "gmtModified": 1517217645000,
        "productKey": "a1xxxxCW",
        "productId": 87634,
        "dataFormat": "ALINK_FORMAT",
        "netType": "NET_WIFI",
        "productSecret": "tfbxxxxKKj",
        "nodeType": "DEVICE",
        "gmtCreate": 1517208303000,
        "name": "風(fēng)扇",
        "region": "cn-shanghai",
        "rbacTenantId": "755ED7C7810xxxxxxxxBC48BF0247",
        "categoryId": 285,
        "status": "RELEASE_STATUS"
    },
    "id": "6aad0b12-2192-xxxx-xxxx-08a2bc0b5c2a"
}

量產(chǎn)生成設(shè)備證書(shū)（云端自動(dòng)生成設(shè)備名稱方式）

定義描述

path 版本 描述 是否需要cloudToken
/cloud/amount/device/generate 1.1.2 通過(guò)該接口可自動(dòng)生成設(shè)備證書(shū)（其中設(shè)備名稱由系統(tǒng)分配），生成設(shè)備證書(shū)后，可以直接調(diào)用/living/device/apply/query接口下載設(shè)備證書(shū) 是

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

參數(shù) 類(lèi)型 必填 描述
productKey String 是 物的產(chǎn)品key
amount Int 是 量產(chǎn)的設(shè)備數(shù)量

返回參數(shù)

參數(shù) 類(lèi)型 描述
batchId String 量產(chǎn)批次號(hào)

示例

  • 請(qǐng)求示例 
    {
    "id": "1508232047195",
    "request": {
        "cloudToken": "10904xxxxxxxxf62e29a3ba",
        "apiVer": "1.1.2"
    },
    "params": {
        "productKey": "a1xxxxikl",
        "amount":100
    },
    "version": "1.0"
}
  • 正常返回示例 
    {
    "code": 200,
    "data": "12345"
    "id": "1508232047195"
}

創(chuàng)建量產(chǎn)批次接口（用戶上傳設(shè)備名稱方式）

定義描述

path 版本 描述 是否需要cloudToken
/cloud/device/name/upload 1.1.2 上傳設(shè)備名稱列表獲取批次號(hào) 是
說(shuō)明 該接口需要用戶主動(dòng)上傳要量產(chǎn)設(shè)備的名稱信息，接口會(huì)返回該批量產(chǎn)的批次ID（batchId），但是此時(shí)還未生成設(shè)備證書(shū)信息，需要再調(diào)用“根據(jù)量產(chǎn)批次生成設(shè)備證書(shū)”接口才會(huì)真正生成設(shè)備證書(shū)。

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

參數(shù) 類(lèi)型 必填 描述
productKey String 是 物的產(chǎn)品key
deviceNames Array 是 指定的設(shè)備名稱列表，每批不超過(guò)1000個(gè)

返回參數(shù)

參數(shù) 類(lèi)型 描述
data String 量產(chǎn)批次號(hào)，即batchId

示例

  • 請(qǐng)求示例 
    {
    "id": "1508232047196",
    "request": {
        "cloudToken": "109049c8xxxxxxxxf6f62e29a3ba",
        "apiVer": "1.1.2"
    },
    "params": {
        "productKey": "a1xxxxikl",
    "deviceNames": ["deviceName1","deviceName2"]
    },
    "version": "1.0"
}
  • 正常返回示例 
    {
    "code": 200,
    "data": "12345",
}

根據(jù)量產(chǎn)批次生成設(shè)備證書(shū)（用戶上傳設(shè)備名稱方式）

定義描述

path 版本 描述 是否需要cloudToken
/cloud/name/device/generate 1.1.2 根據(jù)量產(chǎn)批次生成設(shè)備證書(shū)（在用戶上傳設(shè)備名稱的量產(chǎn)場(chǎng)景中使用） 是
說(shuō)明 該接口根據(jù)批次ID（batchId）生成設(shè)備證書(shū)信息，需配合“創(chuàng)建量產(chǎn)批次接口（用戶上傳設(shè)備名稱方式）”使用。

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

參數(shù) 類(lèi)型 必填 描述
productKey String 是 物的產(chǎn)品key
batchId String 是 量產(chǎn)的批次號(hào)

返回參數(shù)

參數(shù) 類(lèi)型 描述
batchId String 量產(chǎn)批次號(hào)

示例

  • 請(qǐng)求示例 
    {
    "id": "1508232047195",
    "request": {
        "cloudToken": "109049c8xxxxxxxx2e29a3ba",
        "apiVer": "1.1.2"
    },
    "params": {
        "productKey": "a1dxxxxkl",
    "batchId": "1"
    },
    "version": "1.0"
}
  • 正常返回示例 
    {
    "code": 200,
    "data": "1",
    "id": "1508232047195"
}

根據(jù)批次ID查詢?cè)O(shè)備證書(shū)列表

定義描述

path 版本 描述 是否需要cloudToken
/living/device/apply/query 1.0.1 根據(jù)批次ID查詢?cè)O(shè)備證書(shū)列表 是

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

參數(shù) 類(lèi)型 必填 描述
applyId String 是 批次ID
pageNo int 是 分頁(yè)查詢頁(yè)，從1開(kāi)始
pageSize int 是 分頁(yè)大小，最大200

返回參數(shù)

參數(shù) 類(lèi)型 描述
totalNum int 該批次的設(shè)備證書(shū)總數(shù)
items json列表 設(shè)備證書(shū)列表

items中參數(shù)說(shuō)明如下

參數(shù) 類(lèi)型 描述
iotId String 設(shè)備的iotId
productKey String 設(shè)備的productKey
deviceName String 設(shè)備的deviceName
deviceSecret String 設(shè)備的deviceSecret
deviceId String 設(shè)備的deviceId
status int 設(shè)備的狀態(tài)：0-未激活；1-已激活

示例

  • 請(qǐng)求示例 
    {
    "request":{        
        "apiVer":"1.0.1",        
        "cloudToken":"921fb5617xxxx45c34e9d074c"    
    },    
    "id":"348f786a-b6b2-xxxx-xxxx-d8a55442399a",    
    "params":{        
        "applyId":"124639",        
        "pageNo":1,        
        "pageSize":2    
     },    
     "version":"1.0"
}
  • 正常返回示例 
    {
    "code":200,
    "data":{
        "totalNum":90,
        "items":[
            {
                "iotId":"07njQmUOxxxx0101",
                "deviceSecret":"g41b3wEtxxxxHo7Rs9",
                "productKey":"a1rxxxxxTs",
                "deviceName":"07nxxxxxa75U",
                "deviceId":"07nxxxxo8kAa75U",
                "status":0
            },
            {
                "iotId":"0aXlIGxxxxBc2000101",
                "deviceSecret":"bLrDcbxxxxxpk3CrKm",
                "productKey":"axxxxTs",
                "deviceName":"0aXxxxx1Bc2",
                "deviceId":"0aXlxxxxc1Bc2",
                "status":0
            }
        ]
    },
    "id":"348f786a-b6b2-xxxx-xxxx-d8a55442399a"
}

創(chuàng)建量產(chǎn)批次接口（NVR產(chǎn)品專用）

定義描述

path 版本 描述 是否需要cloudToken
/living/cloud/product/nvr/device/generate 1.0.0 根據(jù)數(shù)量量產(chǎn)NVR設(shè)備（同時(shí)將IPC子產(chǎn)品設(shè)備進(jìn)行量產(chǎn)） 是

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

參數(shù) 類(lèi)型 必填 描述
productKey String 是 NVR產(chǎn)品的productkey
amount Int 是 量產(chǎn)的NVR設(shè)備數(shù)量，最小為1；最大為10000

返回參數(shù)

參數(shù) 類(lèi)型 描述
data String NVR批次號(hào)

示例

  • 請(qǐng)求示例 
    {
    "id": "1508232047195",
    "request": {
        "cloudToken": "10904xxxxxxxxf62a3ba",
        "apiVer": "1.0.0"
    },
    "params": {
        "productKey": "a1xxxxikl",
        "amount": 1000
    },
    "version": "1.0"
}
  • 正常返回示例 
    {
    "code": 200,
    "data": "11",
    "id": "1508232047195"
}

根據(jù)批次ID查詢?cè)O(shè)備證書(shū)列表（NVR產(chǎn)品專用）

定義描述

path 版本 描述 是否需要cloudToken
/living/cloud/product/nvr/device/cert/query 1.0.0 根據(jù)批次ID查詢?cè)O(shè)備證書(shū)列表 是

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

參數(shù) 類(lèi)型 必填 描述
batchId String 是 批次ID
productKey String 是 NVR產(chǎn)品的productkey
pageNo int 是 分頁(yè)查詢頁(yè)，從1開(kāi)始
pageSize int 是 分頁(yè)大小，最小為1，最大為20

返回參數(shù)

參數(shù) 類(lèi)型 描述
total int 該批次的NVR設(shè)備證書(shū)總數(shù)
NvrDeviceCertList json列表 設(shè)備證書(shū)列表
pageNo int 分頁(yè)查詢頁(yè)，從1開(kāi)始
pageSize int 分頁(yè)大小，最小為1，最大為20

NvrDeviceCertList參數(shù)說(shuō)明如下

參數(shù) 類(lèi)型 描述
ipcNum int 該NVR網(wǎng)關(guān)下子設(shè)備的數(shù)量
subDeviceCertList DeviceInfo數(shù)組 子設(shè)備的設(shè)備證書(shū)列表
nvrDeviceCertInfo DeviceInfo NVR設(shè)備證書(shū)信息

DeviceInfo參數(shù)說(shuō)明如下

iotId String 設(shè)備的iotId
productKey String 設(shè)備的productKey
deviceName String 設(shè)備的deviceName
deviceSecret String 設(shè)備的deviceSecret

示例

  • 請(qǐng)求示例 
    {
    "request":{        
        "apiVer":"1.0.0",        
        "cloudToken":"921fb5617xxxx49d074c"    
    },    
    "id":"348f786a-b6b2-xxxx-xxxx-d8a55442399a",    
    "params":{        
        "batchId":"124639", 
        "productKey":"axxxxxSbfCe",       
        "pageNo":1,        
        "pageSize":2   
     },    
     "version":"1.0"
}
  • 正常返回示例 
    {
    "code":200,
    "data":{
        "NvrDeviceCertList":[
            {
                "subDeviceCertList":[
                    {
                        "iotId":"09cxxxx0101",
                        "deviceSecret":"e2RexxxxMepCL4n",
                        "productKey":"a1xxxx3Q",
                        "deviceName":"09cxxxxFfgn"
                    },
                    {
                        "iotId":"0Ay8zxxxx000101",
                        "deviceSecret":"lYQaxxxxSmdMFC",
                        "productKey":"a1xxxx3Q",
                        "deviceName":"0AyxxxxRpp"
                    },
                    {
                        "iotId":"0Md9bpxxxx00101",
                        "deviceSecret":"ZVflxxxxW5pW",
                        "productKey":"a1xxxx3Q",
                        "deviceName":"0Mdxxxxeoqd"
                    }
                ],
                "nvrDeviceCertInfo":{
                    "iotId":"vcR91xxxx000101",
                    "deviceSecret":"RYV9xxxxXltunD",
                    "productKey":"a1xxxxCe",
                    "deviceName":"vcRxxxxMUf"
                },
                "ipcNum”:3
            }       
        ],
        "totalNum":500,
        "pageNo":235,
        "pageSize":1
    },
    "id":"f0d2acef-xxxx-488b-xxxx-049b95f66a00"
}