接口描述
请求路径:https://mapapi-routes.apigw-gz.didiyunapi.com/api/v1/yawrecovery
请求方法:GET
输入参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
route | 是 | string | 路线坐标点串:lng,lat|lng,lat|…。经纬度小数点后建议不超过6位,至少输入3个点; |
strategy | 否 | string | 默认值0,路线规划策略:0(综合模式)、1(时间最短)、2(距离最短)、3(红绿灯少)、4(少收费)、5(高速优先) |
alternatives | 否 | string | 默认值false,是否返回备选路线,最多3条。有途径点的时候,此参数被忽略。 |
avoid_polygons | 否 | string | 区域避让,当前仅支持矩形区域,最多30个。区域之间“$”分隔,每个区域的经纬度之间“|”分隔 |
avoid_road | 否 | string | 避让道路名,只支持一条。 |
avoids | 否 | string | 避让:1(轮渡)、2(收费)、3(高速)。多种避让类型代码之间“|”分隔 |
plate_number | 否 | string | 限行参数,车牌号,如“京A12345”,也支持7位新能源车牌号 |
location | 是 | string | 车辆信息:当前位置,lng,lat。经纬度小数点后不超过6位 |
speed | 否 | string | 车辆信息:当前速度,KM/小时 |
heading | 否 | string | 车辆信息:车头方向,正北为0,顺时针一周360度 |
输出参数
参数名称 | 类型 | 描述 |
---|---|---|
status | int | 状态码 |
info | string | 状态说明 |
result | Result | 请求返回数据 |
Result:
参数名称 | 类型 | 描述 |
---|---|---|
routes | array<Routes> | 路线json数组 |
Routes:
参数名称 | 类型 | 描述 |
---|---|---|
routeid | string | 路线ID |
strategy | string | 策略 |
toll | float | 此导航方案道路收费金额,单位:元 |
toll_distance | float | 此导航方案道路收费距离长度,单位:米 |
restriction | string | 限行结果:0表示无限行;1打破避让轮渡;2打破避让收费;3打破避让高速;4打破车辆限行;5打破区域避让;6打破道路避让 |
traffic_lights | string | 此路线红绿灯个数 |
distance | int | 距离,单位米 |
duration | int | 时间,单位分 |
legs | array<Legs> | 起点到第一个途径点;途径点之间;最后一个途径点到终点 |
Legs:
参数名称 | 类型 | 描述 |
---|---|---|
distance | string | 路径距离,单位:米 |
duration | int64 | 预计行驶时间,单位:秒 |
outline | string | 路段坐标点串,lng,lat;lng,lat;... |
错误码
示例
请求:
curl -X GET \
'https://mapapi-routes.apigw-gz.didiyunapi.com/api/v1/yawrecovery?route=116.455436,39.944591|116.503729,39.96229|116.548573,39.96583&location=116.480158,39.962733'\
--header 'Authorization: AppCode XXX'
输出:
{
"status":0,
"info":"OK",
"result":{
"routes":[
{
"routeid":"491552626cdebc3ca13df6787817fcfd",
"strategy":"",
"toll":"",
"toll_distance":"",
"restriction":"",
"traffic_lights":"",
"distance":12303,
"duration":1829,
"legs":[
{
"distance":12303,
"duration":1829,
"outline":"116.42495,39.97705;116.42576,39.97706;"
}
]
}
]
}
}