CollisionAvoidance/docs/official_api.md

3.4 KiB
Raw Blame History

数据接口对接方案

第1章 位置数据接口对接方案

1.1 登录认证

  1. 登录接口http://IP:端口/login
  2. 请求方式post
  3. 参数username、password
  4. 示例:http://127.0.0.1:8080/login?username=XXXX&password=XXXX 5、返回值 data 为返回的鉴权token后续接口需要再header中携带data所有的数据是一个token不要截断 示例:{     "status": 200,     "msg": "登入成功",     "data": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3MzI3ODMwOTAsInVzZXJuYW1lIjoiYWRtaW4ifQ.y9feEL_9NT8UzED9NNkb0Ln6C-PBoufiSHWobWe5vWY" }

1.2 航空器位置数据接入

数据来源:接入并转发从空管接收到的融合数据

  1. 接口地址http://IP:端口/openApi/getCurrentFlightPositions

  2. 请求方式get需要在 Header 中携带认证信息,字段名为 Authorization值为认证接口返回的token

  3. 返回格式:以 JSON 格式返回数据一次请求返回List集合对象

  4. 数据结构:

序号 字段 描述 字段类型 是否必填
1 flightNo 航班号 String
2 longitude 经度 double
3 latitude 纬度 double
4 time 时间戳UTC 时间) long
5 altitude 海拔高度 double
6 trackNumber 航迹号 String

1.3 车辆位置数据接入

数据来源:仅传递目前机场已接入的车辆位置数据

  1. 接口地址http://IP:端口/openApi/getCurrentVehiclePositions

  2. 请求方式get需要在 Header 中携带认证信息,字段名为 Authorization值为认证接口返回的token

  3. 返回格式:以 JSON 格式返回数据一次请求返回List集合对象

  4. 数据结构:

序号 字段 描述 字段类型 是否必填
1 vehicleNo 车牌号 String
2 longitude 经度 double
3 latitude 纬度 double
4 time 时间戳 long
5 direction 方向 double
6 speed 速度 double

第2章 无人车控制接口对接方案

2.1 无人车控制指令

2.1.1 接口地址: http://IP:端口/openApi/emergency_control

2.1.2 请求方法POST

2.1.3 请求参数:

| 序号 | 字段名字 | 是否必选 | 类型 | 说明 |

|-----|------|------|----------|----------|

| 1 | messageName | 是 | string | messageName 是 EmergencyControl 固定值 |

| 2 | messageUniqueId | 是 | string | messageUniqueId 是 string |

| 3 | messageTimestamp | 是 | string | messageTimestamp 是 string 2023-04-24 17:15:44.276341 |

| 4 | origin | 可选 | string | "Vehicle" |

| 5 | vehicleID | 是 | string | 根据项目车号的格式 |

| 6 | operationType | 是 | string | "RESUME" or "STOP" |

| 7 | StopType | 是 | string | "jerk" : 急停 "slow" : 缓停 |

| 8 | reason | 可选 | string | 停止/恢复的原因 |

2.1.4 请求参数:


request : {

"messageName" : "EmergencyControl",

"messageUniqueId" : "68f79d1a-e27f-11ed-b28c-2cf05d9c2649", "messageTimestamp":"2023-04-24 17:15:44.276341",

"origin" : "Vehicle",

"vehicleID" : "A001",

"operationType" : "RESUME", # RESUME | STOP

"StopType" : "jerk"

}

2.1.5 返回格式:以 JSON 格式返回数据


response : {

"code" : 200,

"msg" : "success",

"error" : ""

}