联犀http协议接入
# 简述
联犀在支持mqtt协议接入的基础上,同样支持http协议的接入,限制为只支持设备上行的消息,如属性控制下发这种是不支持的.
# 认证
http协议采用 basic auth (opens new window)的方式进行认证,需要填写的参数对应如下:
- userName: mqtt协议认证方式中计算出的userName
- password: mqtt协议认证方式中计算出的password
在 Header 添加参数 Authorization,其值为在 Basic 之后拼接空格,以及经过 Base64 编码的 :
示例: Authorization: Basic YWRtaW46MTIzNDU2
apifox接口地址: https://unitedrhino.apifox.cn/api-233401356
# 请求方式
- 域名与端口: 请求的端口和默认web访问的一致
- url:
/api/v1/things/device/edge/send/{handle}/{type}
参数 | 位置 | 必选 | 说明 |
---|---|---|---|
handle | path | 是 | 对应 mqtt topic的第一个 thing ota config 等等 |
type | path | 是 | 操作类型 从topic中提取 物模型下就是 property属性 event事件 action行为 |
productID | header | 否 | 产品id,默认为userName中的设备,如果网关操作子设备,则可以填写子设备的产品ID和设备ID |
deviceName | header | 否 | 设备ID,默认为userName中的设备,如果网关操作子设备,则可以填写子设备的产品ID和设备ID |
- body: body直接填写mqtt协议中的payload
curl示例:
curl --location --request POST 'http://localhost:7777/api/v1/things/device/edge/send/gateway/thing' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic MDBqJjVDNTMxMDRBNkMzNTsxMjAxMDEyNjtXNk1QTTsxODg5MDc2Mjc2NDE3OjhkNGI3MTMzMzUxNTdmYTNhOTMwNzAwYjM1MGVjMjEzYTU5MWJlNmI7aG1hY3NoYTE=' \
--data-raw '{
"method":"report",
"msgToken":"123",
"params":{
"ble_key":"123"
}
}'
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
# 回复
回复是以json格式返回,示例如下:
{
"code": 200,
"msg": "success",
"data": {
"code": 200,
"method": "reportReply",
"msgToken": "123"
}
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
参数 | 说明 |
---|---|
code | 200表示成功 |
msg | code的描述 |
data | data返回mqtt协议订阅后应该返回的报文 |
上次更新: 2024/11/14, 15:40:53