X-Link API 文档-V4.0.0websocket连接登录
- 用户获取token和获取websocket连接信息之后,登录到推送服务器,保持长连接状态,后续会实时推送与该用户相关的数据信息
- 如果作为服务端对接,需要一直保持连接状态,注意考虑断开重连的情况;作为H5客户端,如果切换到后台,建议恢复页面时,重新连接,以保证同步到最新状态
请求参数
| 字段 | 类型 | 必选 | 说明 |
|---|---|---|---|
| token | string | 是 | 登录返回的token |
| allowPBData | bool | 否 | 是否需要返回protubuf,目前暂时不对外 |
推送格式
| 字段 | 类型 | 说明 |
|---|---|---|
| hdr | object | websocket消息头,查看表1定义 |
其它字段则根据不同的消息类型来决定,具体查看每个消息推送消息的定义
表1:websocket消息头
| 字段 | 类型 | 说明 |
|---|---|---|
| code | integer | 状态码 |
| message | string | 信息 |
| msgType | integer | 消息类型 |
| reqSN | integer | 请求序号,每发送一条数据自增1 |
| respSN | integer | 应答序号,为0时为推送消息 |
数据推送
连接登录成功后,第一条数据为车辆在线列表
示例
请求示例
url
ws://localhost:8081/web_session?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhZG1pbkd1aWQiOjYsInVzZXJHdWlkIjo2LCJ1c2VyTmFtZSI6ImxjYWRtaW4iLCJ1c2VyVHlwZSI6MiwibWF4RGV2aWNlTnVtIjo1MDAsIlRva2VuU3RyaW5nIjoiIiwiaXNzIjoibHl6IiwiZXhwIjoxNjk5MDg0NDAxfQ.oWB6nUUyEJo-ZcQEYUCPb0Td9TLbs43N8l3Jw-4zd_4ws://localhost:8081/web_session?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhZG1pbkd1aWQiOjYsInVzZXJHdWlkIjo2LCJ1c2VyTmFtZSI6ImxjYWRtaW4iLCJ1c2VyVHlwZSI6MiwibWF4RGV2aWNlTnVtIjo1MDAsIlRva2VuU3RyaW5nIjoiIiwiaXNzIjoibHl6IiwiZXhwIjoxNjk5MDg0NDAxfQ.oWB6nUUyEJo-ZcQEYUCPb0Td9TLbs43N8l3Jw-4zd_4响应示例
json
{
"hdr":{
"code":200,
"message":"",
"msgType":8000, //查看 消息类型定义
"reqSN":1,
"respSN":0
},"data":{
//具体根据不同的消息类型定义,该字段不一定是data,可能是别的名称,具体查看每个消息的定义
}
}{
"hdr":{
"code":200,
"message":"",
"msgType":8000, //查看 消息类型定义
"reqSN":1,
"respSN":0
},"data":{
//具体根据不同的消息类型定义,该字段不一定是data,可能是别的名称,具体查看每个消息的定义
}
}