Appearance
HTTPS业务通用接口
概述
HTTPS业务通用接口,可以满足业务对HTTP协议定制化需求。 业务方需要设备同步上报业务数据时,可使用此接口。
接口地址
../gateway/hmiot-data-server/common/data/reported
请求方式
POST
请求数据类型
Content-Type: application/json
请求示例
json
{
"productKey": "8725dfbe93",
"deviceName": "sn123456789",
"timestamp": 1632445949000,
"sign": "4AC02E63D4D6E80020492B310CAF4C42",
"signMethod": "hmacmd5",
"businessType": "业务类型",
"data": {
"key1": "value1" ,
"key2": "value2" ,
"...": "..."
}
}
请求参数说明
参数名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
productKey | String | 是 | 产品唯一标识。 |
deviceName | String | 是 | 设备唯一标识。 |
timestamp | String | 是 | 当前时间的时间戳。 |
sign | String | 是 | 签名。 加签方法:将提交给服务器的参数(sign、signMethod除外)按照字母顺序排序,然后将参数和值依次拼接(无拼接符号)。通过signMethod指定的加签算法,使用设备的deviceSecret,对加签内容进行加签。 加签计算示例如下: hmac_md5(deviceSecret, deviceNamesn1234productKey8725timestamp163*)。 |
signMethod | String | 是 | 签名方法,目前支持hmacmd5、hmacsha1、hmacsha256。 |
businessType | String | 是 | 业务类型。 |
data | Object | 否 | 请求业务数据对象。 |
key1 | String | 是 | 字段名称 |
value1 | other | 是 | 字段的值 |
响应示例
json
{
"code": {
"code": "0",
"msg": "操作成功"
},
"result": {
"key1": "value1" ,
"key2": "value2" ,
"...": "..."
}
}
响应参数说明
参数名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
code | Object | 是 | 调用结果对象。 |
code | String | 是 | 0为成功,非0为失败。 |
msg | String | 是 | 此次请求结果说明,成功或失败,具体的失败原因等信息。 |
result | Object | 是 | 返回结果数据对象。 |
key1 | String | 是 | 字段名称 |
value1 | other | 是 | 字段的值 |