Product management service

• Query the product list for a project
• Query a single product
• Generate device certificates in a batch (cloud-generated device names)
• Create a production batch by uploading device names
• Generate device certificates from a production batch (using uploaded device names)
• Query the device certificate list by batch ID
• Create a production batch (for NVR products)
• Query the device certificate list by batch ID (for NVR products)

Query the product list of a project

Description

Request parameters

Response parameters

Examples

• Request example

  {
      "id": 1508232047194,
      "request": {
          "cloudToken": "109049c80xxxxxxxx6f62e29a3ba",
          "apiVer": "1.1.0"
      },
      "params": {
          "pageNo" : 1,
          "pageSize" : 10 
      },
      "version": "1.0"
  }

• Successful response example

  {
      "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"
  }

Query a single product

Description

Request parameters

Response parameters

Examples

• Sample request

  {
      "id": 1508232047194,
      "request": {
          "cloudToken": "109049c8xxxxxxxxf6f62e29a3ba",
          "apiVer": "1.1.0"
      },
      "params": {
          "productKey": "a1dxxxxkl"
      },
      "version": "1.0"
  }

• Sample success response

  {
      "code": 200,
      "data": {
          "gmtModified": 1517217645000,
          "productKey": "a1xxxxCW",
          "productId": 87634,
          "dataFormat": "ALINK_FORMAT",
          "netType": "NET_WIFI",
          "productSecret": "tfbxxxxKKj",
          "nodeType": "DEVICE",
          "gmtCreate": 1517208303000,
          "name": "Fan",
          "region": "cn-shanghai",
          "rbacTenantId": "755ED7C7810xxxxxxxxBC48BF0247",
          "categoryId": 285,
          "status": "RELEASE_STATUS"
      },
      "id": "6aad0b12-2192-xxxx-xxxx-08a2bc0b5c2a"
  }

Generate device certificates in a batch (cloud-generated device names)

Description

Request parameters

Response parameters

Examples

• Request example

  {
      "id": "1508232047195",
      "request": {
          "cloudToken": "10904xxxxxxxxf62e29a3ba",
          "apiVer": "1.1.2"
      },
      "params": {
          "productKey": "a1xxxxikl",
          "amount":100
      },
      "version": "1.0"
  }

• Successful response example

  {
      "code": 200,
      "data": "12345"
      "id": "1508232047195"
  }

Create a production batch by uploading device names

Description

Request parameters

Response parameters

Examples

• Request example

  {
      "id": "1508232047196",
      "request": {
          "cloudToken": "109049c8xxxxxxxxf6f62e29a3ba",
          "apiVer": "1.1.2"
      },
      "params": {
          "productKey": "a1xxxxikl",
      "deviceNames": ["deviceName1","deviceName2"]
      },
      "version": "1.0"
  }

• Successful response example

  {
      "code": 200,
      "data": "12345",
  }  

Generate device certificates from a production batch (using uploaded device names)

Description

Request parameters

Response parameters

Examples

• Request example

  {
      "id": "1508232047195",
      "request": {
          "cloudToken": "109049c8xxxxxxxx2e29a3ba",
          "apiVer": "1.1.2"
      },
      "params": {
          "productKey": "a1dxxxxkl",
      "batchId": "1"
      },
      "version": "1.0"
  }

• Successful response example

  {
      "code": 200,
      "data": "1",
      "id": "1508232047195"
  }                     

Query the device certificate list by batch ID

Description

Request parameters

Response parameters

The following table describes the parameters in items.

Examples

• Request example

  {
  "request":{
          "apiVer":"1.0.1",
          "cloudToken":"921fb5617xxxx45c34e9d074c"
      },
      "id":"348f786a-b6b2-xxxx-xxxx-d8a55442399a",
      "params":{
          "applyId":"124639",
          "pageNo":1,
          "pageSize":2
       },
       "version":"1.0"
  }

• Successful response example

  {
      "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"
  }

Create a production batch (for NVR products)

Description

Request parameters

Response parameters

Examples

• Request example

  {
      "id": "1508232047195",
      "request": {
          "cloudToken": "10904xxxxxxxxf62a3ba",
          "apiVer": "1.0.0"
      },
      "params": {
          "productKey": "a1xxxxikl",
          "amount": 1000
      },
      "version": "1.0"
  }

• Successful response example

  {
      "code": 200,
      "data": "11",
      "id": "1508232047195"
  }

Query the device certificate list by batch ID (for NVR products)

Description

Request parameters

Response parameters

The following table describes the parameters in NvrDeviceCertList.

The following table describes the parameters in DeviceInfo.

Examples

• Request example

  {
  "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"
  }

• Successful response example

  {
  "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"
  }