配网服务

更新时间：2018-11-19 19:38:49

提供一组与设备配网和绑定相关的服务接口，通过本组接口可以实现蓝牙、gprs、Wi-Fi设备的用户绑定流程，本组接口还包含了子设备入网流程所需的相关操作接口。

蓝牙设备绑定

定义描述

请求参数

返回参数

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.2",
        "iotToken": "token"
    },
    "params": {
        "deviceInfoForCipher": {
            "deviceName": "xxxx",
            "productId": "001e7",
            "sign": "xxxxxxx",
            "signMethod": "hmacSha1",
            "signParams": {
                "mac":"xxx"
            },
            "groupIds":["xxxxx"]

        }
    }
}

正常返回示例

{
    "code": 200,
    "data": "xxxx",
    "message": "success"
}

错误码

附录一.签名算法

蓝牙设备进行身份认证，蓝牙不传pk传的是productId
验签是将productKey + deviceName + map里的参数  按照字典进行升序排序，然后组成kv串即为待加密的签名
支持hmacSha1,hmacSha256,hmacMd5 忽略大小写
sign规则 hmac_md5(deviceSecret, clientId***deviceName***productKey***timestamp***)
        hmac_sha1(deviceSecret, clientId***deviceName***productKey***timestamp***)
        hmac_sha256(deviceSecret, clientId***deviceName***productKey***timestamp***)
        sha256(clientId***deviceName***deviceSecret***productKey***timestamp***)

获取发现设备列表

定义描述

请求参数

返回参数

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.2",
        "iotToken": "token"
    },
    "params": {
        "pageSize": 10，
        "pageNum": 1
    }
}

正常返回示例

{
    "code": 200,
    "data": {
        "totalNum":12,
        "items":[
            {
                "gmtCreate":xxx,
                "gmtModified":xxx,
                "identityId":"xxx",
                "regIotId":"xxx",
                "regProductKey":"xxx",
                "regDeviceName":"xxx",
                "enrolleeIotId":"xxx",
                "enrolleeProductKey":"xxx",
                "enrolleeDeviceName":"xxx",
                "bssid":"xxx",
                "ssid":"xxx",
                "rssi":"xxx",
                "type":0,
                "status":1
            }
        ]
    },
    "message": "success"
}

错误码

本地发现设备列表信息过滤

定义描述

请求参数

列表结构

返回参数

(0:LORA,3:WIFI,4:ZIGBEE,5:BT,6:CELLULAR,7:ETHERNET,8:NET_OTHER) |
| nodeType | String | 是 | 节点类型
(0:DEVICE,1:GATEWAY) |
| categoryKey | String | 是 | 品类标识符 |
| categoryName | String | 是 | 品类名称 |
| categoryId | String | 是 | 归属品类id |

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.4",
        "iotToken": "token"
    },
    "params": {
        "iotDevices": [{
            "productKey": "a1v12d34vm",
            "deviceName": "xxxxxx"
        }, {
            "productKey": "a1v12d77bb",
            "deviceName": "xxxxxx"
        }],
        "groupId": "houseId123"
    }

}

正常返回示例

{
    "code": 200,
    "data":[
            {
                "productKey":"a1v12d34vm",
                "deviceName":"xxxxxx",
                "netType":3,
                "nodeType":0,
                "categoryKey":"xxx",
                "categoryName":"xxx",
                "categoryId":14
            }
    ],
    "message": "success"
}

错误码

GPRS设备绑定

定义描述

请求参数

返回参数

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.2",
        "iotToken": "token"
    },
    "params": {
        "productKey": "xxx"，
        "deviceName": "xxx"，
        "groupIds":["xxxx"]
    }
}

正常返回示例

{
    "code": 200,
    "data": "xxxx",
    "message": "success"
}

错误码

获取秘钥

定义描述

请求参数

返回参数

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.2",
        "iotToken": "token"
    },
    "params": {
        "deviceInfoForCipher": {
            "deviceName": "xxxx",
           "productKey": "xxxx",
            "productId": "001e7",
           "cipherType": 3, 
            "random": "00000000000000000000000000000000",
            "params": {
                "mac":"xxx"
            }
        }
    }
}

正常返回示例

{
    "code": 200,
    "data": "xxxx",
    "message": "success"
}

错误码

附录一.秘钥生成规则

cipherType=3 一型一密：根据productKey查询productSecret，密钥算法sha256(contentByteArray)。
contentByteArray=productSecret.getByte()+0x2c+hexToByte(random) 

cipherType=4 一机一密：根据productKey和deviceName查询deviceSecret，密钥算法sha256(contentByteArray)。
contentByteArray=deviceSecret.getByte()+0x2c+hexToByte(random)

(暂不开放)
cipherType=5 一厂一密：根据model查询manufacturer的accessKey&accessSecret（目前model新增时需要手动录入），密钥算法sha256(contentByteArray)。
contentByteArray=accessSecret.getByte()+0x2c+hexToByte(random)

cipherType=6 BLE一型一密：密钥算法sha256(contentByteArray)。
contentByteArray=productSecret.getByte()+0x2c+hexToByte(mac)+0x2c+hexToByte(random)

cipherType=7 BLE一机一密：密钥算法sha256(contentByteArray)
contentByteArray=deviceSecret.getByte()+0x2c+hexToByte(mac)+0x2c+hexToByte(random)

Wi-Fi设备绑定

定义描述

请求参数

返回参数

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.2",
        "iotToken": "token"
    },
    "params": {
        "productKey": "xxx"，
        "deviceName": "xxx"，
        "token":"xxx",
        "groupIds":["xxx"]
    }
}

正常返回示例

{
    "code": 200,
    "data": "xxxx",
    "message": "success"
}

错误码

网关接入子设备

定义描述

请求参数

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.2",
        "iotToken": "token"
    },
    "params": {
        "iotId": "xxxxxxxxxxxxxx",
        "productKey": "xxxxxxxxx", 
        "time": 60                   
    }
}

正常返回示例

{
    "id":"xxx",
    "code":200,
    "message":"success",
    "data":null
}

错误码

解除子设备网络拓扑

定义描述

请求参数

返回参数

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.2",
        "iotToken": "token"
    },
    "params": {
        "iotId": "xxxxxxxxxxxxxx",
        "subIotId": "xxxxxxxxx"                
    }
}

正常返回示例

{
    "id":"xxx",
    "code":200,
    "message":"success",
    "data":null
}

错误码

子设备绑定

定义描述

请求参数

返回参数

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.2",
        "iotToken": "token"
    },
    "params": {
        "productKey": "xxx"，
        "deviceName": "xxx",
        "groupIds":["xxx"]
    }
}

正常返回示例

{
    "code": 200,
    "data": "xxxx",
    "message": "success"
}

错误码

解绑子设备

定义描述

请求参数

返回参数

示例

请求示例

{
    "request": {
        "iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.2"
    },
    "id": 1508212818676,
    "params": {
        "productKey": "xxx"，
        "deviceName": "xxx"
    },
    "version": "1.0"
}

正常返回示例

{
    "id":"xxx",
    "code":200,
    "message":"success",
    "data":null
}

错误码

获取可配网的品类列表

定义描述

请求参数

返回参数

示例

请求示例

{
    "request": {
        "iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.2"
    },
    "id": 1508212818676,
    "params": {
        "pageNo":1,
        "pageSize":20
    },
    "version": "1.0"
}

正常返回示例

{
    "code":200,
    "data":{
        "data":[
            {
                "categoryKey":"WallSwitch",
                "categoryName":"入墙开关",
                "id":71,
                "image":"http://xxx/xxx/xxx.png",
                "panelTemplateId":"3",
                "superId":xxx
            }
        ],
        "pageNo":1,
        "pageSize":20,
        "total":1
    },
    "message":"success"
}

错误码

查询可配网的产品列表

定义描述

请求参数

返回参数

示例

请求示例

{
    "request": {
        "iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.2"
    },
    "id": 1508212818676,
    "params": {
        "pageNo":1,
        "pageSize":20,
        "categoryKey":"xxx"
    },
    "version": "1.0"
}

正常返回示例

{
    "code":200,
    "data":{
        "data":[
            {
                "accessMethod":0,
                "categoryId":xx,
                "categoryKey":"ShowerRoom",
                "categoryName":"淋浴房",
                "dataFormat":1,
                "domain":"xxx",
                "gmtCreate":1524470775000,
                "gmtModified":1524470775000,
                "name":"M6xx淋浴房",
                "netType":3,
                "nodeType":0,
                "productKey":"xx",
                "region":"cn-shanghai",
                "status":0,
                "tenantId":"xxxx"
            }
        ],
        "pageNo":1,
        "pageSize":20,
        "total":1
    },
    "message":"success"
}

错误码