路径规划 最后更新时间: 2022年04月28日
产品介绍
路径规划API是一套以HTTP形式提供的步行、公交、驾车查询及行驶距离计算接口,返回JSON 或 XML格式的查询数据,用于实现路径规划功能的开发。
由于道路/数据/算法的变更,很可能存在间隔一段时间后请求相同起终点的经纬度返回不同结果。
使用API前您需先申请Key,若无高德地图API账号需要先申请账号。
适用场景
- 无需展现地图的场景下,进行线路查询,如以线路结果页形式展现换乘方案;
- 根据返回线路数据,自行开发线路导航。
使用限制
服务调用量的限制请点击这里查阅。
使用说明
第一步,申请”Web服务API”密钥(Key);
第二步,拼接HTTP请求URL,第一步申请的Key需作为必填参数一同发送;
第三步,接收HTTP请求返回的数据(JSON或XML格式),解析数据。
如无特殊声明,接口的输入参数和输出数据编码全部统一为UTF-8。
简单示例:
https://restapi.amap.com/v3/direction/driving?origin=116.45925,39.910031&destination=116.587922,40.081577&output=xml&key=<用户的key>
针对步行、公交、驾车这三种路径规划的接口,如果希望能够实现批量请求,可以考虑使用批量请求接口(https://lbs.amap.com/api/webservice/guide/api/batchrequest)
步行路径规划
- 接口简介:
步行路径规划 API 可以规划100KM以内的步行通勤方案,并且返回通勤方案的数据。
- 步行路径规划API URL
URL |
https://restapi.amap.com/v3/direction/walking?parameters |
请求方式 |
GET |
parameters 代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。
- 请求参数
参数名 |
含义 |
规则说明 |
是否必须 |
缺省值 |
|
---|---|---|---|---|---|
key |
请求服务权限标识 |
用户在高德地图官网申请Web服务API类型KEY |
必填 |
无 |
|
origin |
出发点 |
规则: lon,lat(经度,纬度), “,”分割,如117.500244, 40.417801 经纬度小数点不超过6位 |
必填 |
无 |
|
destination |
目的地 |
规则: lon,lat(经度,纬度), “,”分割,如117.500244, 40.417801 经纬度小数点不超过6位 |
必填 |
无 |
|
sig |
数字签名 |
可选 |
无 |
||
output |
返回数据格式类型 |
可选值:JSON,XML |
可选 |
JSON |
|
callback |
回调函数 |
callback值是用户定义的函数名称,此参数只在output=JSON时有效 |
可选 |
无 |
- 服务示例
https://restapi.amap.com/v3/direction/walking?origin=116.434307,39.90909&destination=116.434446,39.90816&key=<用户的key>
参数 |
值 |
备注 |
必选 |
---|---|---|---|
origin |
lon,lat(经度,纬度),如117.500244, 40.417801 经纬度小数点不超过6位 |
是 |
|
destination |
lon,lat(经度,纬度),如117.500244, 40.417801 经纬度小数点不超过6位 |
是 |
- 返回结果参数说明
步行规划的响应结果的格式由请求参数output指定
名称 |
含义 |
规则说明 |
||||
---|---|---|---|---|---|---|
status |
返回状态 |
值为0或1 1:成功;0:失败 |
||||
info |
返回的状态信息 |
status为0时,info返回错误原;否则返回“OK”。详情参阅info状态表 |
||||
count |
返回结果总数目 |
|||||
route |
路线信息列表 |
|||||
origin |
起点坐标 |
|||||
destination |
终点坐标 |
|||||
paths |
步行方案 |
|||||
distance |
起点和终点的步行距离 |
单位:米 |
||||
duration |
步行时间预计 |
单位:秒 |
||||
steps |
返回步行结果列表 |
|||||
step |
每段步行方案 |
|||||
instruction |
路段步行指示 |
|||||
road |
道路名称 |
|||||
distance |
此路段距离 |
单位:米 |
||||
orientation |
方向 |
|||||
duration |
此路段预计步行时间 |
|||||
polyline |
此路段坐标点 |
|||||
action |
步行主要动作 |
详情见步行动作列表 |
||||
assistant_action |
步行辅助动作 |
详情见步行动作列表 |
||||
walk_type |
这段路是否存在特殊的方式 |
0,普通道路 1,人行横道 3,地下通道 4,过街天桥 5,地铁通道 6,公园 7,广场 8,扶梯 9,直梯 10,索道 11,空中通道 12,建筑物穿越通道 13,行人通道 14,游船路线 15,观光车路线 16,滑道 18,扩路 19,道路附属连接线 20,阶梯 21,斜坡 22,桥 23,隧道 30,轮渡 |
- 步行动作列表
主要动作列表 |
辅助动作列表 |
|
---|---|---|
无基本导航动作 |
无辅助导航动作 |
|
左转 |
左转 |
|
右转 |
右转 |
|
向左前方 |
向左前方 |
|
向右前方 |
向右前方 |
|
向左后方 |
向左后方 |
|
向右后方 |
向右后方 |
|
直行 |
往后走 |
|
靠左 |
往前走 |
|
靠右 |
靠左 |
|
通过人行横道 |
靠右 |
|
通过过街天桥 |
通过人行横道 |
|
通过地下通道 |
通过过街天桥 |
|
通过广场 |
通过地下通道 |
|
到道路斜对面 |
通过广场 |
|
到达目的地 |
||
进入右侧道路 |
||
进入左侧道路 |
公交路径规划
- 接口简介:
公交路径规划 API 可以规划综合各类公共(火车、公交、地铁)交通方式的通勤方案,并且返回通勤方案的数据。
- 公交路径规划API URL:
URL |
https://restapi.amap.com/v3/direction/transit/integrated?parameters |
请求方式 |
GET |
parameters 代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。
- 请求参数
参数名 |
含义 |
规则说明 |
是否必须 |
缺省值 |
|
---|---|---|---|---|---|
key |
请求服务权限标识 |
用户在高德地图官网申请Web服务API类型KEY |
必填 |
无 |
|
origin |
出发点 |
规则: lon,lat(经度,纬度), “,”分割,如117.500244, 40.417801 经纬度小数点不超过6位 |
必填 |
无 |
|
destination |
目的地 |
规则: lon,lat(经度,纬度), “,”分割,如117.500244, 40.417801 经纬度小数点不超过6位 |
必填 |
无 |
|
city |
城市/跨城规划时的起点城市 |
目前支持市内公交换乘/跨城公交的起点城市。 可选值:城市名称/citycode |
必填 |
无 |
|
cityd |
跨城公交规划时的终点城市 |
跨城公交规划必填参数。 可选值:城市名称/citycode |
可选 ( 跨城必填 ) |
无 |
|
extensions |
返回结果详略 |
可选值:base(default)/all base:返回基本信息;all:返回全部信息 |
可选 |
base |
|
strategy |
公交换乘策略 |
可选值: 0:最快捷模式 1:最经济模式 2:最少换乘模式 3:最少步行模式 5:不乘地铁模式 |
可选 |
0 |
|
nightflag |
是否计算夜班车 |
可选值:0:不计算夜班车 1:计算夜班车 |
可选 |
0 |
|
date |
出发日期 |
根据出发时间和日期,筛选可乘坐的公交路线,格式示例:date=2014-3-19。在无需设置预计出发时间时,请不要在请求之中携带此参数。 |
可选 |
无 |
|
time |
出发时间 |
根据出发时间和日期,筛选可乘坐的公交路线,格式示例:time=22:34。在无需设置预计出发时间时,请不要在请求之中携带此参数。 |
可选 |
无 |
|
sig |
数字签名 |
可选 |
无 |
||
output |
返回数据格式类型 |
可选值:JSON,XML |
可选 |
JSON |
|
callback |
回调函数 |
callback值是用户定义的函数名称,此参数只在output=JSON时有效 |
可选 |
无 |
- 服务示例
https://restapi.amap.com/v3/direction/transit/integrated?origin=116.481499,39.990475&destination=116.465063,39.999538&city=010&output=xml&key=<用户的key>
参数 |
值 |
备注 |
必选 |
---|---|---|---|
origin |
lon,lat(经度,纬度),如117.500244, 40.417801 经纬度小数点不超过6位 |
是 |
|
destination |
lon,lat(经度,纬度),如117.500244, 40.417801 经纬度小数点不超过6位 |
是 |
|
city |
支持市内公交换乘/跨城公交的起点城市,规则:城市名称/citycode |
是 |
|
cityd |
跨城公交规划必填参数。规则:城市名称/citycode |
否 |
|
strategy |
0 1 2 3 5 |
0:最快捷模式;1:最经济模式;2:最少换乘模式;3:最少步行模式;5:不乘地铁模式 |
否 |
nightflag |
0 1 |
是否计算夜班车,1:是;0:否 |
否 |
- 返回结果参数说明
公交规划的响应结果的格式由请求参数output指定。
名称 |
含义 |
规则说明 |
||||
---|---|---|---|---|---|---|
status |
返回状态 |
值为0或1 1:成功;0:失败 |
||||
info |
返回的状态信息 |
status为0时,info返回错误原;否则返回“OK”。详情参阅info状态表 |
||||
count |
公交换乘方案数目 |
|||||
route |
公交换乘信息列表 |
|||||
origin |
起点坐标 |
|||||
destination |
终点坐标 |
|||||
distance |
起点和终点的步行距离 |
单位:米 |
||||
taxi_cost |
出租车费用 |
单位:元 |
||||
transits |
公交换乘方案列表 |
|||||
transit |
公交换乘方案 |
|||||
cost |
此换乘方案价格 |
单位:元 |
||||
duration |
此换乘方案预期时间 |
单位:秒 |
||||
nightflag |
是否是夜班车 |
0:非夜班车;1:夜班车 |
||||
walking_distance |
此方案总步行距离 |
单位:米 |
||||
segments |
换乘路段列表 |
|||||
walking |
此路段步行导航信息 |
详见步行方案信息列表 |
||||
bus |
此路段公交导航信息 |
详见公交方案信息列表 |
||||
entrance |
地铁入口 |
只在地铁路段有值,详见出入口信息列表 |
||||
exit |
地铁出口 |
只在地铁路段有值,详见出入口信息列表 |
||||
railway |
乘坐火车的信息 |
详情见只在地铁路段有值,详见火车换乘信息列表 |
- 步行方案信息列表
名称 |
含义 |
规则说明 |
||
---|---|---|---|---|
origin |
起点坐标 |
|||
destination |
终点坐标 |
|||
distance |
每段线路步行距离 |
单位:米 |
||
duration |
步行预计时间 |
单位:秒 |
||
steps |
步行路段列表 |
|||
instruction |
此段路的行走介绍 |
|||
road |
路的名字 |
|||
distance |
此段路的距离 |
|||
duration |
此段路预计消耗时间 |
单位:秒 |
||
polyline |
此段路的坐标 |
|||
action |
步行主要动作 |
|||
assistant_action |
步行辅助动作 |
- 公交方案信息列表
名称 |
含义 |
规则说明 |
||
---|---|---|---|---|
buslines |
步行路段列表 |
|||
departure_stop |
此段起乘站信息 |
格式如:中关村 |
||
name |
站点名字 |
|||
id |
站点id |
|||
location |
站点经纬度 |
|||
arrival_stop |
此段下车站 |
格式如:中关村 |
||
name |
站点名字 |
|||
id |
站点id |
|||
location |
站点经纬度 |
|||
name |
公交路线名称 |
格式如:445路(南十里居–地铁望京西站) |
||
id |
公交路线id |
|||
type |
公交类型 |
格式如:地铁线路 |
||
distance |
公交行驶距离 |
单位:米 |
||
duration |
公交预计行驶时间 |
单位:秒 |
||
polyline |
此路段坐标集 |
格式为坐标串,如:116.481247,39.990704;116.481270,39.990726 |
||
start_time |
首班车时间 |
格式如:0600,代表06:00 |
||
end_time |
末班车时间 |
格式如:2300,代表23:00 |
||
via_num |
此段途经公交站数 |
|||
via_stops |
此段途经公交站点列表 |
|||
name |
途径公交站点信息 |
|||
id |
公交站点编号 |
|||
location |
公交站点经纬度 |
- 出入口信息列表
name |
入口名称 |
|
---|---|---|
location |
入口经纬度 |
- 火车换乘信息列表
名称 |
说明 |
|
---|---|---|
id |
线路id编号 |
|
time |
该线路车段耗时 |
|
name |
线路名称 |
|
trip |
线路车次号 |
|
distance |
该item换乘段的行车总距离 |
|
type |
线路车次类型 |
|
departure_stop |
火车始发站信息 |
|
id |
上车站点ID |
|
name |
上车站点名称 |
|
location |
上车站点经纬度 |
|
adcode |
上车站点所在城市的adcode |
|
time |
上车点发车时间 |
|
start |
是否始发站,1表示为始发站,0表示非始发站 |
|
arrival_stop |
火车到站信息 |
|
id |
下车站点ID |
|
name |
下车站点名称 |
|
location |
下车站点经纬度 |
|
adcode |
下车站点所在城市的adcode |
|
time |
到站时间,如大于24:00,则表示跨天 |
|
end |
是否为终点站,1表示为终点站,0表示非终点站 |
|
via_stop |
途径站点信息,extensions=all时返回 |
|
name |
途径站点的名称 |
|
id |
途径站点的ID |
|
location |
途径站点的坐标点 |
|
time |
途径站点的进站时间,如大于24:00,则表示跨天 |
|
wait |
途径站点的停靠时间,单位:分钟 |
|
alters |
聚合的备选方案,extensions=all时返回 |
|
id |
备选方案ID |
|
name |
备选线路名称 |
|
spaces |
仓位及价格信息 |
|
code |
仓位编码 |
|
cost |
仓位费用 |
- 火车路线类型表
线路类型代码 |
公共交通工具备注 |
线路类型代码 |
公共交通工具备注 |
---|---|---|---|
2010 |
普客火车 |
2015 |
T字头的特快火车 |
2011 |
G字头的高铁火车 |
2016 |
K字头的快车火车 |
2012 |
D字头的动车火车 |
2017 |
L字头,Y字头的临时火车 |
2013 |
C字头的城际火车 |
2018 |
S字头的郊区线火车 |
2014 |
Z字头的直达特快火车 |
- 仓位级别表
仓位级别 |
仓位备注 |
仓位级别 |
仓位备注 |
---|---|---|---|
0 |
不分仓位级别 |
20 |
火车高级软卧下铺 |
9 |
特等座 |
21 |
火车商务座 |
10 |
火车硬座 |
22 |
长途汽车座席 |
11 |
火车软座 |
23 |
长途汽车卧席上铺 |
12 |
火车软座1等座 |
24 |
长途汽车卧席中铺 |
13 |
火车软座2等座 |
25 |
长途汽车卧席下铺 |
14 |
火车硬卧上铺 |
30 |
飞机经济舱 |
15 |
火车硬卧中铺 |
31 |
飞机商务舱 |
16 |
火车硬卧下铺 |
40 |
客轮经济舱 |
17 |
火车软卧上铺 |
41 |
客轮3等舱 |
18 |
火车软卧下铺 |
42 |
客轮2等舱 |
19 |
火车高级软卧上铺 |
43 |
客轮豪华舱 |
驾车路径规划
- 接口简介:
驾车路径规划 API 可以规划以小客车、轿车通勤出行的方案,并且返回通勤方案的数据。
- 驾车路径规划API URL:
URL |
https://restapi.amap.com/v3/direction/driving?parameters |
请求方式 |
GET |
parameters 代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。
- 请求参数
参数名称 |
含义 |
规则说明 |
是否必须 |
缺省值 |
---|---|---|---|---|
key |
用户唯一标识 |
用户在高德地图官网申请 |
是 |
无 |
origin |
出发点 |
经度在前,纬度在后,经度和纬度用”,”分割,经纬度小数点后不得超过6位。格式为x1,y1|x2,y2|x3,y3。 由于在实际使用过程中,存在定位飘点的情况。为了解决此类问题,允许传入多个起点用于计算车头角度。 最多允许传入3个坐标对,每对坐标之间距离必须超过2m。 虽然对每对坐标之间长度没有上限,但是如果超过4米会有概率性出现不准确的情况。使用三个点来判断距离和角度的有效性,如果两者都有效,使用第一个点和最后一个点计算的角度设置抓路的角度,规划路径时以最后一个坐标对进行规划。 |
是 |
无 |
destination |
目的地 |
经度在前,纬度在后,经度和纬度用”,”分割,经纬度小数点后不得超过6位。 |
是 |
无 |
originid |
出发点poiid |
当起点为POI时,建议填充此值。 |
否 |
无 |
destinationid |
目的地poiid |
当终点为POI时,建议填充此值。 |
否 |
无 |
origintype |
起点的poi类别 |
当用户知道起点POI的类别时候,建议填充此值 |
否 |
无 |
destinationtype |
终点的poi类别 |
当用户知道终点POI的类别时候,建议填充此值 |
否 |
无 |
strategy |
驾车选择策略 |
下方10~20的策略,会返回多条路径规划结果。(高德地图APP策略也包含在内,强烈建议从此策略之中选择) 下方策略 0~9的策略,仅会返回一条路径规划结果。 下方策略返回多条路径规划结果 10,返回结果会躲避拥堵,路程较短,尽量缩短时间,与高德地图的默认策略也就是不进行任何勾选一致 11,返回三个结果包含:时间最短;距离最短;躲避拥堵 (由于有更优秀的算法,建议用10代替) 12,返回的结果考虑路况,尽量躲避拥堵而规划路径,与高德地图的“躲避拥堵”策略一致 13,返回的结果不走高速,与高德地图“不走高速”策略一致 14,返回的结果尽可能规划收费较低甚至免费的路径,与高德地图“避免收费”策略一致 15,返回的结果考虑路况,尽量躲避拥堵而规划路径,并且不走高速,与高德地图的“躲避拥堵&不走高速”策略一致 16,返回的结果尽量不走高速,并且尽量规划收费较低甚至免费的路径结果,与高德地图的“避免收费&不走高速”策略一致 17,返回路径规划结果会尽量的躲避拥堵,并且规划收费较低甚至免费的路径结果,与高德地图的“躲避拥堵&避免收费”策略一致 18,返回的结果尽量躲避拥堵,规划收费较低甚至免费的路径结果,并且尽量不走高速路,与高德地图的“避免拥堵&避免收费&不走高速”策略一致 19,返回的结果会优先选择高速路,与高德地图的“高速优先”策略一致 20,返回的结果会优先考虑高速路,并且会考虑路况躲避拥堵,与高德地图的“躲避拥堵&高速优先”策略一致 下方策略仅返回一条路径规划结果 0,速度优先,此路线不一定距离最短 1,费用优先,不走收费路段,且耗时最少的路线 2,距离优先,仅走距离最短的路线,但是可能存在穿越小路/小区的情况 3,速度优先,不走快速路,例如京通快速路(因为策略迭代,建议使用13) 4,躲避拥堵,但是可能会存在绕路的情况,耗时可能较长 5,多策略(同时使用速度优先、费用优先、距离优先三个策略计算路径)。 其中必须说明,就算使用三个策略算路,会根据路况不固定的返回一~三条路径规划信息。 6,速度优先,不走高速,但是不排除走其余收费路段 7,费用优先,不走高速且避免所有收费路段 8,躲避拥堵和收费,可能存在走高速的情况,并且考虑路况不走拥堵路线,但有可能存在绕路和时间较长 9,躲避拥堵和收费,不走高速 |
否 |
0 |
waypoints |
途经点 |
经度和纬度用”,”分割,经度在前,纬度在后,小数点后不超过6位,坐标点之间用”;”分隔 最大数目:16个坐标点。如果输入多个途径点,则按照用户输入的顺序进行路径规划 |
否 |
无 |
avoidpolygons |
避让区域 |
区域避让,支持32个避让区域,每个区域最多可有16个顶点 经度和纬度用”,”分割,经度在前,纬度在后,小数点后不超过6位,坐标点之间用”;”分隔,区域之间用”|”分隔。如果是四边形则有四个坐标点,如果是五边形则有五个坐标点; 同时传入避让区域及避让道路,仅支持避让道路; 避让区域不能超过81平方公里,否则避让区域会失效。 |
否 |
无 |
avoidroad |
避让道路名 |
只支持一条避让道路 |
否 |
无 |
province |
用汉字填入车牌省份缩写,用于判断是否限行 |
例如:京 |
否 |
无 |
number |
填入除省份及标点之外,车牌的字母和数字(需大写)。用于判断限行相关。 |
例如:NH1N11 支持6位传统车牌和7位新能源车牌 |
否 |
无 |
cartype |
车辆类型 |
0:普通汽车(默认值) |
否 |
0 |
ferry |
在路径规划中,是否使用轮渡 |
0:使用渡轮(默认) |
否 |
0 |
roadaggregation |
是否返回路径聚合信息 |
false:不返回路径聚合信息 true:返回路径聚合信息,在steps上层增加roads做聚合 |
否 |
false |
nosteps |
是否返回steps字段内容 |
当取值为0时,steps字段内容正常返回; 当取值为1时,steps字段内容为空; |
否 |
0 |
sig |
数字签名 |
数字签名认证用户必填 |
否 |
无 |
output |
返回数据格式类型 |
可选值:JSON,XML |
否 |
JSON |
callback |
回调函数 |
callback值是用户定义的函数名称,此参数只在output=JSON时有效 |
否 |
无 |
extensions |
返回结果控制 |
可选值:base/all base:返回基本信息;all:返回全部信息 |
是 |
base |
- 服务示例
https://restapi.amap.com/v3/direction/driving?origin=116.481028,39.989643&destination=116.465302,40.004717&extensions=all&output=xml&key=<用户的key>
参数 |
值 |
备注 |
必选 |
---|---|---|---|
origin |
lon,lat(经度,纬度),如117.500244, 40.417801 经纬度小数点不超过6位 |
是 |
|
destination |
lon,lat(经度,纬度),如117.500244, 40.417801 经纬度小数点不超过6位 |
是 |
|
originid |
当起点为POI时,建议填充此值 |
否 |
|
destinationid |
当终点为POI时,建议填充此值 |
否 |
|
extensions |
base all |
base:返回基本信息;all:返回全部信息 |
否 |
strategy |
参见上方strategy的说明 |
否 |
|
waypoints |
途经点,最大数目:16个坐标点 |
否 |
|
avoidpolygons |
避让区域,如果是四边形则有四个坐标点,如果是五边形则有五个坐标点 |
否 |
|
avoidroad |
只支持一条避让道路,如:广顺北大街 |
否 |
- 返回结果参数说明
驾车规划的响应结果的格式由请求参数output指定。
名称 | 含义 | 规则说明 | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
status | 结果状态值,值为0或1 | 0:请求失败;1:请求成功 | |||||||||||||||||||
info | 返回状态说明 | status为0时,info返回错误原因,否则返回“OK”。详情参阅info状态表 | |||||||||||||||||||
count | 驾车路径规划方案数目 | ||||||||||||||||||||
route | 驾车路径规划信息列表 | ||||||||||||||||||||
origin | 起点坐标 | 规则: lon,lat(经度,纬度), “,”分割,如117.500244, 40.417801 经纬度小数点不超过6位 | |||||||||||||||||||
destination | 终点坐标 | 规则: lon,lat(经度,纬度), “,”分割,如117.500244, 40.417801 经纬度小数点不超过6位 | |||||||||||||||||||
taxi_cost | 打车费用 | 单位:元,注意:extensions=all时才会返回 | |||||||||||||||||||
paths | 驾车换乘方案 | ||||||||||||||||||||
path | 驾车换乘方案 | ||||||||||||||||||||
distance | 行驶距离 | 单位:米 | |||||||||||||||||||
duration | 预计行驶时间 | 单位:秒 | |||||||||||||||||||
strategy | 导航策略 | ||||||||||||||||||||
tolls | 此导航方案道路收费 | 单位:元 | |||||||||||||||||||
restriction | 限行结果 | 0 代表限行已规避或未限行,即该路线没有限行路段 1 代表限行无法规避,即该线路有限行路段 |
|||||||||||||||||||
traffic_lights | 红绿灯个数 | ||||||||||||||||||||
toll_distance | 收费路段距离 | ||||||||||||||||||||
steps | 导航路段 | ||||||||||||||||||||
step | 导航路段 | 详情见导航路段信息step列表 |
- 导航路段信息step列表
名称 |
含义 |
规则说明 |
|||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
instruction |
行驶指示 |
||||||||||
orientation |
方向 |
||||||||||
road |
道路名称 |
||||||||||
distance |
此路段距离 |
单位:米 |
|||||||||
tolls |
此段收费 |
单位:元 |
|||||||||
toll_distance |
收费路段距离 |
单位:米 |
|||||||||
toll_road |
主要收费道路 |
||||||||||
polyline |
此路段坐标点串 |
格式为坐标串,如:116.481247,39.990704;116.481270,39.990726 |
|||||||||
action |
导航主要动作 |
详见驾车动作列表 |
|||||||||
assistant_action |
导航辅助动作 |
详见驾车动作列表 |
|||||||||
tmcs |
驾车导航详细信息 |
其中包含tmc对象 |
|||||||||
distance |
此段路的长度 |
单位:米 |
|||||||||
status |
此段路的交通情况 |
未知、畅通、缓行、拥堵、严重拥堵 |
|||||||||
polyline |
此段路的轨迹 |
规格:x1,y1;x2,y2 |
- 驾车动作列表
注意:extensions=all时以下信息才会返回
主要动作列表 |
|
---|---|
无基本导航动作 左转 右转 向左前方行驶 向右前方行驶 向左后方行驶 向右后方行驶 左转调头 直行 靠左 靠右 进入环岛 离开环岛 减速行驶 |
辅助动作列表 |
---|
无辅助导航动作 进入主路 进入辅路 进入高速 进入匝道 进入隧道 进入中间岔道 进入右岔路 进入左岔路 进入右转专用道 进入左转专用道 进入中间道路 进入右侧道路 进入左侧道路 靠右行驶进入辅路 靠左行驶进入辅路 靠右行驶进入主路 靠左行驶进入主路 靠右行驶进入右转专用道 进入轮渡 驶离轮渡 沿当前道路行驶 沿辅路行驶 沿主路行驶 到达出口 到达服务区 到达收费站 到达途经地 到达目的地的 绕环岛左转 绕环岛右转 绕环岛直行 绕环岛调头 小环岛不数出口 到达复杂路口,走右边第一出口 到达复杂路口,走右边第二出口 到达复杂路口,走右边第三出口 到达复杂路口,走右边第四出口 到达复杂路口,走右边第五出口 到达复杂路口,走左边第一出口 到达复杂路口,走左边第二出口 到达复杂路口,走左边第三出口 到达复杂路口,走左边第四出口 到达复杂路口,走左边第五出口 进入调头专用路 |
骑行路径规划
- 接口简介:
骑行路径规划用于规划骑行通勤方案,规划时不会考虑路况;考虑天桥、单行线、封路等情况。
- 骑行路径规划API URL:
URL |
https://restapi.amap.com/v4/direction/bicycling?parameters |
请求方式 |
GET |
parameters代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。
- 请求参数
参数名 |
含义 |
规则说明 |
是否必填 |
缺省值 |
---|---|---|---|---|
key |
请求服务权限标识 |
用户在高德地图官网申请Web服务API类型KEY |
是 |
无 |
origin |
出发点经纬度 |
填入规则:X,Y,采用”,”分隔,例如“ 117.500244, 40.417801 ” 小数点后不得超过6位 |
是 |
无 |
destination |
目的地经纬度 |
填入规则:X,Y,采用”,”分隔,例如“ 117.500244, 40.417801 ” 小数点后不得超过6位 |
是 |
无 |
- 返回结果参数说明
名称 |
类型 |
含义 |
规则说明 |
|||
---|---|---|---|---|---|---|
data |
对象 |
里面包含具体内容 |
业务数据字段 |
|||
origin |
String |
起点坐标 |
格式:X,Y |
|||
destination |
String |
终点坐标 |
格式:X,Y |
|||
paths |
数组 |
骑行方案列表信息 |
||||
distance |
数值 |
起终点的骑行距离 |
单位:米 |
|||
duration |
数值 |
起终点的骑行时间 |
单位:秒 |
|||
steps |
数组 |
具体骑行结果 |
||||
instruction |
String |
路段骑行指示 |
例如:“骑行54米右转” |
|||
road |
String |
此段路道路名称 |
有可能出现空,需要特别指出,日后会用null表示 例如:“建国门北大街” |
|||
distance |
数值 |
此段路骑行距离 |
||||
orientation |
String |
此段路骑行方向 |
例如:“南” |
|||
duration |
数值 |
此段路骑行耗时 |
单位:秒 |
|||
polyline |
String |
此段路骑行的坐标点 |
格式:X,Y;X1,Y1;X2,Y2 |
|||
action |
String |
此段路骑行主要动作 |
内容为中文指示。 骑行·主要动作,可能为空,也可能 为左转、右转、向左前方行驶、向右前方行驶等 |
|||
assistant_action |
String |
此段路骑行辅助动作 |
内容为中文提示。 例如:“到达目的地” |
|||
errcode |
数值 |
返回结果码 |
0,表示成功 |
|||
errdetail |
String |
具体错误原因 |
此字段会详细说明错误原因 |
|||
errmsg |
String |
返回状态说明 |
OK代表成功 |
- 服务示例
https://restapi.amap.com/v4/direction/bicycling?origin=116.434307,39.90909&destination=116.434307,39.90909&key=<用户的key>
参数 |
值 |
备注 |
必选 |
---|---|---|---|
origin |
起点经纬度 |
是 |
|
destination |
终点经纬度 |
是 |
未来路径规划
- 接口简介
适用于查询未来7天的路径规划结果,本服务仅针对企业开发者开放。
- 未来路径规划API URL:
URL |
https://restapi.amap.com/v4/etd/driving?parameters |
请求方式 |
POST |
- 请求参数
参数 |
含义 |
规则 |
是否必填 |
缺省值 |
---|---|---|---|---|
key |
请求服务权限标识 |
用户在高德地图官网申请Web服务API类型KEY |
是 |
无 |
origin |
出发点 |
规则: lon,lat(经度,纬度), “,”分割,如117.500244, 40.417801 经纬度小数点不超过6位 |
否 |
无 |
destination |
目的地 |
规则: lon,lat(经度,纬度), “,”分割,如117.500244, 40.417801 经纬度小数点不超过6位 |
否 |
无 |
strategy |
规划策略 |
1.返回的结果考虑路况,尽量躲避拥堵而规划路径,与高德地图的“躲避拥堵”策略一致 2.返回的结果不走高速,与高德地图“不走高速”策略一致 3.返回的结果尽可能规划收费较低甚至免费的路径,与高德地图“避免收费”策略一致 4.返回的结果考虑路况,尽量躲避拥堵而规划路径,并且不走高速,与高德地图的“躲避拥堵&不走高速”策略一致 5.返回的结果尽量不走高速,并且尽量规划收费较低甚至免费的路径结果,与高德地图的“避免收费&不走高速”策略一致 6.返回路径规划结果会尽量的躲避拥堵,并且规划收费较低甚至免费的路径结果,与高德地图的“躲避拥堵&避免收费”策略一致 7.返回的结果尽量躲避拥堵,规划收费较低甚至免费的路径结果,并且尽量不走高速路,与高德地图的“避免拥堵&避免收费&不走高速”策略一致 8.返回的结果会优先选择高速路,与高德地图的“高速优先”策略一致 9.返回的结果会优先考虑高速路,并且会考虑路况躲避拥堵,与高德地图的“躲避拥堵&高速优先”策略一致 10.不考虑路况,返回速度最优、耗时最短的路线,但是此路线不一定距离最短 11.避让拥堵&速度优先&避免收费 |
否 |
1 |
province |
用汉字填入车牌省份缩写,用于判断是否限行 |
例如:京 |
否 |
无 |
number |
填入除省份及标点之外,车牌的字母和数字(需大写)。用于判断限行相关。 |
例如:NH1N11 支持6位传统车牌和7位新能源车牌 |
否 |
无 |
cartype |
车辆类型 |
0:普通汽车(默认值) |
否 |
0 |
firsttime |
出发时间,第一个时间戳 |
unix时间戳,精确到秒,必须是未来时间,如果小于当前时间会报错。 |
是 |
无 |
interval |
时间间隔 |
单位:秒 |
是 |
无 |
count |
时间点个数 |
最多支持48个 |
是 |
无 |
callback |
回调函数 |
callback值是用户定义的函数名称 |
否 |
无 |
- 返回结果参数说明
返回参数 |
含义说明 |
||||
---|---|---|---|---|---|
errcode |
返回状态编码,0表示成功 |
||||
errmsg |
返回状态说明。 成功时返回OK,其他错误返回错误信息。 |
||||
errdetail |
返回错误详细原因 |
||||
data |
返回结果数据 |
||||
paths |
路径规划方案,列表 |
||||
distance |
行驶距离,单位:米 |
||||
traffic_lights |
红绿灯个数 |
||||
steps |
导航路段,列表 |
||||
adcode |
途径区域的区域代码 |
||||
road |
道路名称 |
||||
distance |
路段距离 |
||||
toll |
道路属性字段,是否收费,0:不收费,1:收费。 |
||||
polyline |
路段坐标点串 |
||||
time_infos |
不同时间的规划以及信息列表 |
||||
starttime |
出发时间,Unix时间戳精确到毫秒 |
||||
elements |
路线列表 |
||||
pathindex |
对应的路线 |
||||
duration |
总时长,单位:分钟 |
||||
tolls |
总收费,单位:元 |
||||
restriction |
0:代表限行已规避或未限行,即该路线没有限行路段 |
||||
tmcs |
路况信息 |
||||
status |
路况状态 |
||||
polyline |
路段坐标点 |
货车路径规划
- 货车路径规划API URL:
URL |
https://restapi.amap.com/v4/direction/truck?parameters |
请求方式 |
GET |
- 注意事项:
- parameters代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。
- 当avoidpolygons参数特别长时,需要使用POST方式请求,
- 如果只需要使用结果中的距离、时间字段,建议设置nosteps=1,可以大幅度提升性能。
- 货车限行分为两种:客观限制(道路客观条件产生的宽高重限制)和政策限行(行政部门规定的限制),路径规划时会根据传入参数分别处理。如果传入了宽高重等参数就按参数考虑客观限制,如果没传入则不考虑;如果传入了车牌号(province和number),会考虑政策限行,如果没有传入则不考虑。
- 请求参数
参数名 |
含义 |
规则说明 |
是否必填 |
缺省值 |
---|---|---|---|---|
key |
请求服务权限标识 |
用户在高德地图官网申请Web服务API类型KEY |
是 |
无 |
origin |
出发点经纬度 |
填入规则:X,Y,采用”,”分隔,例如“ 117.500244, 40.417801 ”,小数点后不得超过6位 |
是 |
无 |
originid |
出发POI的唯一编号 |
当起点为POI时,建议填充此值。填充此值以后,会影响路径规划的结果。举例来说:当起点的经纬度在高架桥上时,若填充了此值我们会以此POI的经纬度作为更高优的处理。 |
否 |
无 |
originidtype |
出发POI的类型 |
当起点为POI时,建议填充此值。 |
否 |
无 |
destination |
目的地经纬度 |
填入规则:X,Y,采用”,”分隔,例如“ 117.500244, 40.417801 ”,小数点后不得超过6位 |
是 |
无 |
destinationid |
终点POI的唯一编号 |
当终点为POI时,建议填充此值。填充此值以后,会影响路径规划的结果,会以此POI的经纬度作为更高优的处理。 |
否 |
无 |
destinationtype |
终点POI的类型 |
当终点为POI时,建议填充此值。 |
否 |
无 |
diu |
设备唯一编号 |
android 的 imei,ios 的 idfa |
否 |
无 |
strategy |
驾车选择策略 |
1,躲避拥堵:返回的结果考虑路况,尽量躲避拥堵而规划路径;对应导航SDK货导策略12; 2,不走高速:返回的结果考虑路况,不走高速;对应导航SDK货导策略13; 3,避免收费:返回的结果考虑路况,尽可能规划收费较低甚至免费的路径;对应导航SDK货导策略14; 4,躲避拥堵+不走高速:返回的结果考虑路况,尽量躲避拥堵,并且不走高速;对应导航SDK货导策略15; 5,避免收费+不走高速:返回的结果考虑路况,尽量不走高速,并且尽量规划收费较低甚至免费的路径结果;对应导航SDK货导策略16; 6,躲避拥堵+避免收费:返回的结果考虑路况,尽量的躲避拥堵,并且规划收费较低甚至免费的路径结果;对应导航SDK货导策略17; 7,躲避拥堵+避免收费+不走高速:返回的结果考虑路况,尽量躲避拥堵,规划收费较低甚至免费的路径结果,并且尽量不走高速路;对应导航SDK货导策略18; 8,高速优先:返回的结果考虑路况,会优先选择高速路;对应导航SDK货导策略19; 9,躲避拥堵+高速优先:返回的结果考虑路况,会优先考虑高速路,并且会考虑路况躲避拥堵;对应导航SDK货导策略20; 10,无路况速度优先:基于历史的通行速度数据,不考虑当前路况的影响,返回速度优先的路;如果不需要路况干扰计算结果,推荐使用此策略;(导航SDK货导策略无对应,真实导航时均会考虑路况) 11,默认策略:返回的结果会考虑路况,躲避拥堵,速度优先以及费用优先;500Km规划以内会返回多条结果,500Km以外会返回单条结果;考虑路况情况下的综合最优策略,推荐使用;对应导航SDK货导策略10; 12,无路况+不走高速:基于历史的通行速度数据,不考虑当前路况的影响,且不走高速路线,返回速度优先的路。 |
否 |
1 |
waypoints |
途经点 |
规则:经度和纬度用“,”分隔,坐标点之间用”;”分隔 。最大数目:16个坐标点,如果输入多个途径点,则按照用户输入的顺序进行路径规划” |
否 |
无 |
size |
车辆大小 |
高德此分类依据国标。1:微型车,2:轻型车(默认值),3:中型车,4:重型车 |
是 |
无 |
height |
车辆高度 |
单位米,取值[0 – 25.5]米,默认 1.6 米,会严格按照填写数字进行限行规避,请按照车辆真实信息合理填写。 |
否 |
1.6 |
width |
车辆宽度 |
单位米,取值[0 – 25.5]米,默认 2.5 米,会严格按照填写数字进行限行规避,请按照车辆真实信息合理填写。 |
否 |
2.5 |
load |
车辆总重 |
单位吨,取值[0 – 100]吨,默认 10 吨,会严格按照填写数字进行限行规避,请按照车辆真实信息合理填写。 总重的含义是核定载重加上车辆自重。 |
否 |
10 |
weight |
货车核定载重 |
单位吨,取值[0 – 100)吨,默认 0.9 吨,会严格按照填写数字进行限行规避,请按照车辆真实信息合理填写。 核定载重的含义是可装载货物的最大重量。 |
否 |
0.9 |
axis |
车辆轴数 |
单位个,取值[0 –255]个,默认 2个轴,会严格按照填写数字进行限行规避,请按照车辆真实信息合理填写。轴数影响通行费用的计算。 |
否 |
2 |
province |
车牌省份 |
用汉字填入车牌省份缩写。用于判断是否限行 |
否 |
无 |
number |
车牌详情 |
填入除省份及标点之外的字母和数字(需大写),用于判断限行相关。 支持6位传统车牌和7位新能源车牌。 |
否 |
无 |
cartype |
车辆类型 |
0:普通货车(默认值) 1:纯电动货车 2:插电混动货车 |
否 |
0 |
exempts |
豁免限行政策 |
支持上传需要豁免的限行政策id,此政策id需要通过限行接口获取。最多支持传入10条限行政策进行豁免,传入后的政策,在算路时将不算为限行。 |
否 |
0 |
avoidpolygons |
避让区域 |
区域避让,支持100个避让区域,每个区域最多可有16个顶点,每个区域的最大面积是100平方公里。经度和纬度用””,””分隔,坐标点之间用”;”分隔,区域之间用”|”分隔。如果是四边形则有四个坐标点,如果是五边形则有五个坐标点。 |
否 |
无 |
has_pass |
是否使用通行证信息 |
提前在高德合作城市的小程序、APP中进行过办证操作的,可以选择。选择“是”后,高德算路引擎将查询车牌对应的通行证数据,参考通行证规定的路线进行算路,取值has_pass=true 或者 has_pass=false |
否 |
FALSE |
showpolyline |
是否返回路线数据 |
当取值为1时,steps与tmcs下的polyline数据会正常返回;当取值为0时,steps与tmcs下的polyline数据为空。 |
否 |
1 |
nosteps |
是否返回steps字段内容 |
当取值为0时,steps字段内容正常返回;当取值为1时,steps字段内容为空。 |
否 |
0 |
- 返回结果参数说明
返回字段 |
含义 |
规则说明 |
||||||
---|---|---|---|---|---|---|---|---|
data |
数据体 |
|||||||
count |
总共返回路线数 |
|||||||
route |
里面包含距离路线信息 |
|||||||
origin |
起点坐标 |
|||||||
destination |
终点坐标 |
|||||||
paths |
驾车的具体方案 |
|||||||
distance |
此方案的行驶距离 |
|||||||
duration |
此方案的耗时 |
|||||||
strategy |
导航策略 |
|||||||
tolls |
此导航方案道路收费金额 |
单位:元 |
||||||
toll_distance |
此导航方案道路收费距离长度 |
单位:米 |
||||||
restriction |
限行结果 |
0,未知(未输入完整/正确车牌号信息时候显示) 1,已规避限行 2,起点限行 3,途径点在限行区域内(设置途径点才出现此报错) 4,途径限行区域 5,终点限行 |
||||||
traffic_lights |
此方案红绿灯总数 |
单位:个 |
||||||
steps |
具体方案 |
|||||||
instruction |
行驶指示 |
例如:沿火器营路向南行驶112米左转 |
||||||
orientation |
方向 |
|||||||
road |
道路名 |
|||||||
distance |
此路段距离 |
单位:米 |
||||||
tolls |
此段收费金额 |
单位:元 |
||||||
toll_distance |
收费路段距离 |
单位:米 |
||||||
toll_road |
主要收费道路 |
|||||||
duration |
此路段预计时间 |
|||||||
polyline |
此路段的坐标点 |
|||||||
action |
导航主要动作 |
例如:左转 |
||||||
assistant_action |
导航辅助动作 |
例如:左转 |
||||||
tmcs |
驾车导航详细信息 |
|||||||
distance |
此段路长度 |
|||||||
status |
路况 |
0:未知 1:畅通 2:缓行 3:拥堵 |
||||||
polyline |
此分段的路线 |
|||||||
cities |
途径城市列表(此节点及子节点目前还在开发,会在日后实现) |
|||||||
name |
途径城市名字 |
|||||||
citycode |
途径城市citycode |
|||||||
adcode |
途径城市adcode |
|||||||
districts |
途径地 |
|||||||
name |
途径地名字 |
|||||||
adcode |
途径地adcode |
|||||||
errcode |
返回结果编码 |
0表示成功 |
||||||
errmsg |
返回状态说明 |
成功时返回OK,否则返回错误原因 |
||||||
errdetail |
错误具体原因 |
- 服务示例
https://restapi.amap.com/v4/direction/truck?width=2.5&strategy=5&size=2&weight=10&axis=2&origin=116.481008%2C39.989625&destination=116.414217%2C40.061741&height=1.6&load=0.9&key=<用户的key>
物流距离测量矩阵
- API URL
URL |
https://tsapi.amap.com/v1/logistics/route/matrix |
请求方式 |
POST |
特别注意:物流距离测量矩阵是物流API服务收费接口,您如果申请试用或者正式应用都请通过工单系统提交商务合作类工单进行沟通。
- 请求:
参数名 |
含义 |
规则说明 |
是否必须 |
缺省值 |
---|---|---|---|---|
key |
请求服务权限标识 |
用户在高德地图官网申请Web服务API类型KEY |
必填 |
无 |
ID |
任务请求的唯一标识 |
确保输入ID的唯一性, 推荐使用请求订单ID |
必填 |
无 |
origin |
出发点 |
lng,lat(经度在前;”,”分割;纬度在后)例如:117.500244,40.417801 经纬度建议小数点后不超过6位; 格式为x,y。 |
必填 |
无 |
destinations |
目的地 |
lng,lat(经度在前;”,”分割;纬度在后)例如:117.500244,40.417801 经纬度建议小数点后不超过6位; 格式为x,y ; x,y ; x,y…..。经纬度之间通过“;”分割;上限100个经纬度; |
必填 |
无 |
strategy |
驾车路线规划策略 |
躲避拥堵策略: 0.躲避拥堵 1. 躲避拥堵,高速优先; 2. 躲避拥堵,不走高速; 3. 躲避拥堵,避免收费; 4. 躲避拥堵,不走高速且避免收费; 速度优先策略: 10. 速度优先 11. 速度优先,高速优先; 12. 速度优先,不走高速; 13. 速度优先,避免收费; 14. 速度优先,不走高速且避免收费; 距离优先策略: 20. 距离优先 21. 距离优先,高速优先; 22. 距离优先,不走高速; 23. 距离优先,避免收费; 24.距离优先,不走高速且避免收费; |
可选 |
10 |
restriction |
规避限行 |
是否开启规避限行 0.不规避限行 1.规避限行 |
可选 |
0 |
commuteMode |
行驶方式 |
行驶方式 0:直线距离 1:行驶距离 |
可选 |
1 |
vehicle |
车辆信息 |
当commuteMode=1时,传入vehicle才会有效果; vehicle包含车辆的 1. 车辆类型(type), 默认货车, 2. 车牌号(plate),默认为空 3. 车辆大小(size),默认轻型车, 小客车类型不生效, 4. 车辆长度(length), 小客车类型不生效 5. 车辆高度(height),小客车类型不生效 6. 车辆宽度(width),小客车类型不生效, 7. 车辆总重(weight),小客车类型不生效, 8. 车辆载重(load),小客车类型不生效, 9. 车辆轴数(axis),小客车类型不生效 以上内容的vaule标准可查看附录1 |
当restriction=1时,vehicle必填,(其中vehicle.type、vehicle.size必填);若type为货车,plate必填 |
- 请求示例:
https://tsapi.amap.com/v1/logistics/route/matrix?key= <用户的key>
{
"key": " <用户的key> ",
"origin": "118.755478,32.060347",
"destinations": "118.79393,32.0148;118.781399,31.998133;119.066357,32.056564;119.788021,31.345896",
"strategy": "24",
"restriction": "1",
"commuteMode": "1",
"vehicle": {
"plate": "京CZ3018",
"type": "1",
"size": "2",
"length": "2",
"height": "2",
"width": "2",
"load": "2",
"weight": "2",
"axis": "2"
}
}
- 返回:
参数 |
类型 |
说明 |
---|---|---|
errcode |
string |
错误码 |
errmsg |
string |
错误描述 |
errdetail |
string |
错误详情 |
data |
||
/number |
int |
根据输入顺序的起点/终点对排序 |
/origin |
string |
lng,lat(经度在前;”,”分割;纬度在后)直接返回用户输入内容 格式为x,y。 |
/destination |
string |
lng,lat(经度在前;”,”分割;纬度在后)直接返回用户输入内容 格式为x,y。 |
/code |
int |
是否计算成功 0:请求成功 2:算路失败 20:起点无效 40:终点无效 111:起点抓路失败 113:终点抓路失败 142:无法计算出有效路线 |
/distance |
int |
距离,单位:米 |
/duration |
int |
时间,单位:秒 注:行驶距离为直线距离(commuteMode=0), 此字段返回空 |
/toll |
int |
道路收费信息, 单位元 |
/restriction |
int |
限行信息, 仅开启规避限行策略才返回该字段; 0:可规避限行/不限行 1:不可规避限行 注:行驶距离为直线距离(commuteMode=0), 此字段返回空 |
- 对照表:
序号 |
errcode |
errmsg |
状态描述 |
问题排查策略 |
---|---|---|---|---|
1 |
10000 |
OK |
请求正常 |
请求正常 |
2 |
10001 |
INVALID_USER_KEY |
key不正确或过期 |
发起请求时,传入的key不正确或者过期 |
3 |
10002 |
SERVICE_NOT_AVAILABL E,Solution URL “http://lbs.a map.com/api/webservice/inf o/” |
没有权限使用相应 的服 务或者请求 接口的路径 拼写 错误 |
1.没有权限使用相应的服务,例如:申请了WEB定位功能的key,却使用该key访问逆地理编码功能时,就会返回该错误。反之亦然 2.请求接口的路径拼写错误 |
4 |
10003 |
DAILY_QUERY_OVER_LIMI T,Solution URL “http://lbs.am ap.com/api/webservice/info/” |
访问已超出日访问量 |
日访问量超限,被系统自动封停,第二天0:0 0会自动解封 |
5 |
10004 |
ACCESS_TOO_FREQUEN T,Solution URL”http://lbs.am ap.com/api/webservice/info/” |
单位时间内访问过于频繁 |
单位时间内(1分钟)访问量超限,被系统自动封停,下一分钟自动解封。 |
6 |
10005 |
INVALID_USER_IP |
IP白名单出错,发送请求的服务器IP,不在IP白名单内 |
在LBS官网控制台设置的IP白名单不正确。 白名单中未添加对应服务器的出口IP。可 到”控制台>配置”中设定IP白名单 |
7 |
10006 |
INVALID_USER_DOMAIN |
绑定域名无效 |
为Key绑定的域名无效,需要在官网控制台重新设置 |
8 |
10007 |
INVALID_USER_SIGNATURE |
数字签名未通过验证 |
数字签名未通过。在key控制台中,开启 了”数字签名”功 能,但没有按照指定算法生 成”数字签名 |
9 |
10008 |
INVALID_USER_SCODE |
MD5安全码未通过验证 |
需要判定key绑定的SHA1,package是否与sd k包里的一致 |
10 |
10009 |
USERKEY_PLAT_NOMATCH |
请求key与绑定平台不符 |
请求中使用的key与绑定平台不符,例如:申请的是JS A PI的key,却用来调Web服务 接口 |
11 |
10010 |
IP_QUERY_OVER_LIMIT,So lution URL “http://lbs.amap.c om/api/webservice/info/” |
IP访问超限 |
未设定IP白名单的开发者使用Key发起请 求, 从单个IP向服务器发送的请求次数超出限制,被系统自动封停 |
12 |
10011 |
NOT_SUPPORT_HTTPS |
服务不支持https请求 |
服务不支持https请求,如果需要申请支持, 请提交工单联系我们 |
13 |
10012 |
INSUFFICIENT_PRIVILEGE S |
权限不足,服务请求被拒绝 |
由于不具备请求该服务的权限,所以服务被拒绝 |
14 |
10013 |
USER_KEY_RECYCLED |
Key被删除 |
Key被删除后无法正常使用 |
15 |
10014 |
QPS_HAS_EXCEEDED_TH E_LIMIT |
QPS超限 |
QPS超出限制,超出部分的请求被拒绝。限流阈值内的请求依旧会正常返回 |
16 |
10015 |
GATEWAY_TIMEOUT |
受单机QPS限流限 制 |
受单机QPS限流限制时出现该问题,建议降低请求的QPS或在控制台提工单联系我们 |
17 |
10016 |
SERVER_IS_BUSY |
服务器负载过高 |
服务器负载过高,请稍后再试 |
18 |
10017 |
RESOURCE_UNAVAILABLE |
所请求的资源不可用 |
所请求的资源不可用 |
19 |
10019 |
CQPS_HAS_EXCEEDED_THE_LIMIT |
使用的某个服务总QPS超限 |
|
20 |
10020 |
CKQPS_HAS_EXCEEDED_THE_LIMIT |
某个Key使用某个服务接口QPS超出限制 |
|
21 |
10021 |
CIQPS_HAS_EXCEEDED_THE_LIMIT |
来自于同一IP的访问,使用某个服务QPS超出限制 |
|
22 |
10022 |
CIKQPS_HAS_EXCEEDED_THE_LIMIT |
某个Key,来自于同一IP的访问,使用某个服务QPS 超出限制 |
|
23 |
10023 |
KQPS_HAS_EXCEEDED_THE_LIMIT |
某个KeyQPS超出限制 |
|
24 |
20000 |
INVALID_PARAMS |
请求参数非法 |
请求参数的值没有按照规范要求填写。例如,某参数值域范围为[1,3],开发者误填了”4″ |
25 |
20001 |
MISSING_REQUIRED_PARAMS |
缺少必填参数 |
缺少接口中要求的必填参数 |
26 |
20002 |
ILLEGAL_REQUEST |
请求协议非法 |
请求协议非法 |
27 |
20003 |
UNKNOWN_ERROR |
其他未知错误 |
其他未知错误 |
35 |
20803 |
OVER_DIRECTION_RANGE |
起点终点距离过长 |
|
36 |
300** |
ENGINE_RESPONSE_DATA_ERROR |
服务响应失败 |
出现3开头的错误码,建议先检查传入参数是否正确,若无法解决,请详细描述错误复现信息,提工单给我们 |
- 附录
Key |
Key名称 |
value说明 |
---|---|---|
plate |
车牌 |
plate_number支持支持6位传统车牌和7位新能源车牌;例:plate_number:京XXXXXX; 当restriction=1的时候, 该字段必传 |
type |
车辆类型 |
0:客车 1:货车(默认) 2:纯电动客车 3:纯电动货车 4:插电式混动客车 5:插电式混动货车 默认值:1 |
size |
车辆大小 |
高德此分类依据国标 仅货车/纯电动货车/插电式混动货车类型生效 1: 微型车 2:轻型车(默认值) 3:中型车 4:重型车 |
length |
车辆长度 |
仅货车/纯电动货车/插电式混动货车类型生效 单位米,取值[0 – 30]米,会严格按照填写数字进行限行规避,请按照车辆真实信息合理填写。 |
height |
车辆高度 |
仅货车/纯电动货车/插电式混动货车类型生效 单位米,取值[0 – 10]米,会严格按照填写数字进行限行规避,请按照车辆真实信息合理填写。 |
width |
车辆宽度 |
仅货车/纯电动货车/插电式混动货车类型生效 单位米,取值[0 – 10]米,会严格按照填写数字进行限行规避,请按照车辆真实信息合理填写。 |
weight |
车辆总重 |
仅货车/纯电动货车/插电式混动货车类型生效 单位吨,取值[0 – 200]吨,会严格按照填写数字进行限行规避,请按照车辆真实信息合理填写。 总重的含义是核定载重加上车辆自重的总质量。 |
load |
车辆载重 |
仅货车/纯电动货车/插电式混动货车类型生效 单位吨,取值[0 – 200]吨,会严格按照填写数字进行限行规避,请按照车辆真实信息合理填写。 核定载重的含义是可装载货物的最大重量。 |
axle |
车辆轴数 |
仅货车/纯电动货车/插电式混动货车类型生效 单位个,取值[0 –50]个,会严格按照填写数字进行限行规避,请按照车辆真实信息合理填写。 |
物流长途距离计算矩阵
创建任务
- API URL
URL |
https://tsapi.amap.com/v1/logistics/route/longmatrix/add |
请求方式 |
POST |
特别注意:物流长途距离计算矩阵是物流API服务收费接口,您如果申请试用或者正式应用都请通过工单系统提交商务合作类工单进行沟通。
- 请求:
参数名 |
含义 |
规则说明 |
是否必须 |
缺省值 |
---|---|---|---|---|
key |
请求服务权限标识 |
用户在高德地图官网申请Web服务API类型KEY |
必填 |
无 |
id |
任务请求的唯一标识 |
确保输入ID的唯一性, 推荐使用请求订单ID(string) |
非必填 |
无 |
origins |
出发点 |
lng,lat(经度在前;”,”分割;纬度在后)例如:117.500244,40.417801 经纬度建议小数点后不超过6位; 格式为x,y。格式为x,y ; x,y ; x,y…..。经纬度之间通过“;”分割;起终点乘积最多支持200(例:10个起点&20个终点) |
必填 |
无(小数点后大于6位, 进行截断处理) |
destinations |
目的地 |
lng,lat(经度在前;”,”分割;纬度在后)例如:117.500244,40.417801 经纬度建议小数点后不超过6位; 格式为x,y ; x,y ; x,y…..。经纬度之间通过“;”分割;起终点乘积最多支持200(例:10个起点&20个终点) |
必填 |
无(小数点后大于6位, 进行截断处理) |
strategy |
驾车路线规划策略 |
躲避拥堵策略: 0.躲避拥堵 1. 躲避拥堵,高速优先; 2. 躲避拥堵,不走高速; 3. 躲避拥堵,避免收费; 4. 躲避拥堵,不走高速且避免收费; 速度优先策略: 10. 速度优先 11. 速度优先,高速优先; 12. 速度优先,不走高速; 13. 速度优先,避免收费; 14. 速度优先,不走高速且避免收费; 距离优先策略: 20. 距离优先 21. 距离优先,高速优先; 22. 距离优先,不走高速; 23. 距离优先,避免收费; 24. 距离优先,不走高速且避免收费; |
可选 |
10 |
vehicle |
车辆信息 |
传入vehicle才会有效果; vehicle包含车辆的 1. 车辆类型(type), 默认货车, 2. 车牌号(plate),默认为空 3. 车辆大小(size),默认轻型车, 小客车类型不生效, 4. 车辆长度(length), 小客车类型不生效 5. 车辆高度(height),小客车类型不生效 6. 车辆宽度(width),小客车类型不生效, 7. 车辆总重(weight),小客车类型不生效, 8. 车辆载重(load),小客车类型不生效, 9. 车辆轴数(axis),小客车类型不生效 以上内容的vaule标准可查看附录1 |
非必传 |
- 请求示例:
curl -X POST \
'https://tsapi.amap.com/v1/logistics/route/longmatrix/add?key=yourkey' \
-H 'content-type: application/json' \
-d '{
"origins":"121.487241,31.229493;121.487242,31.229493",
"destinations":"121.47471,31.234484;121.460119,31.241676",
"strategy":"10",
"vehicle":{
"axis":"2",
"plate":"苏A88V12",
"type":"1",
"size":"1",
"length":"5.95",
"height":"3.35",
"width":"2.35",
"weight":"4.495",
"load":"1.5"
}
}'
- 返回:
参数 |
说明 |
---|---|
errcode |
错误码 |
errmsg |
错误描述 |
errdetail |
错误详情 |
data |
|
/jobId |
返回计算任务ID, 通过此ID进行查询相关计算结果 |
- 返回示例:
add接口返回参数,内容在data字段中,定义jobId,格式:
{
"errcode":"",
"errmsg":"",
"errdetail":"",
"data":{
"jobId":"12345"
}
}
查询任务
- API URL
URL |
https://tsapi.amap.com/v1/logistics/route/longmatrix/query |
请求方式 |
GET |
- 请求:
key |
请求服务权限标识 |
用户在高德地图官网申请Web服务API类型KEY |
必填 |
---|---|---|---|
jobId |
任务请求的唯一标识 |
创建任务时返回ID |
必填 |
- 返回:
参数 |
说明 |
---|---|
errcode |
错误码 |
errmsg |
错误描述 |
errdetail |
错误详情 |
data |
|
/progress |
(-1)-100 来表示进度,状态为100的时候返回data结果 1. 进行中任务: 返回进度状态 2. 完成任务: a. 「未处理」一个都没完成: 返回计算失败 b. 「超时」完成了一部分: 返回progress=-1(代表处理超时), 能够下载 c. 「完成」都完成: 返回progress=100, 能够下载 |
/resultAddress |
返回处理之后结果地址, 具体内容参见下方字段 |
- 返回文件内容:
oss文件存储的是json数组,每个数组元素包括以下字段:
参数 |
类型 |
说明 |
---|---|---|
number |
int |
根据输入顺序的起点/终点对排序,从1开始。 |
origin |
string |
lng,lat(经度在前;”,”分割;纬度在后)直接返回用户输入内容 格式为x,y。 |
destination |
string |
lng,lat(经度在前;”,”分割;纬度在后)直接返回用户输入内容 格式为x,y。 |
code |
int |
是否计算成功 -1: 处理超时, 没有请求引擎的任务 0:请求成功 引擎code=0 其他数值:算路失败 |
distance |
int |
距离,单位:米 |
duration |
int |
时间,单位:秒 |
tolls |
int |
高速费用, 返回0即不收取 |
- 返回示例:
{
"errcode": 10000,
"errmsg": "OK",
"errdetail": null,
"data": {
"progress": 100,
"resultAddress": "http://oss/address"
}
}
- OSS文件示例:
[
{
"number":"1",
"origin":"",
"destination":"",
"code":"",
"distance":"122",
"duration":"122"
},
{
"number":"2",
"origin":"",
"destination":"",
"code":"",
"distance":"122",
"duration":"122"
}
]
- 附录1:车辆信息:
Key |
Key名称 |
value说明 |
---|---|---|
plate |
车牌 |
plate_number支持支持6位传统车牌和7位新能源车牌;例:plate_number:京XXXXXX; 当restriction=1的时候, 该字段必传 |
type |
车辆类型 |
0:客车 1:货车(默认) 2:纯电动客车 3:纯电动货车 4:插电式混动客车 5:插电式混动货车 |
size |
车辆大小 |
高德此分类依据国标 仅货车/纯电动货车/插电式混动货车类型生效 1: 微型车 2:轻型车(默认值) 3:中型车 4:重型车 |
length |
车辆长度 |
仅货车/纯电动货车/插电式混动货车类型生效 单位米,取值[0 – 30]米,会严格按照填写数字进行限行规避,请按照车辆真实信息合理填写。 |
height |
车辆高度 |
仅货车/纯电动货车/插电式混动货车类型生效 单位米,取值[0 – 10]米,会严格按照填写数字进行限行规避,请按照车辆真实信息合理填写。 |
width |
车辆宽度 |
仅货车/纯电动货车/插电式混动货车类型生效 单位米,取值[0 – 10]米,会严格按照填写数字进行限行规避,请按照车辆真实信息合理填写。 |
weight |
车辆总重 |
仅货车/纯电动货车/插电式混动货车类型生效 单位吨,取值[0 – 200]吨,会严格按照填写数字进行限行规避,请按照车辆真实信息合理填写。 总重的含义是核定载重加上车辆自重的总质量。 |
load |
车辆载重 |
仅货车/纯电动货车/插电式混动货车类型生效 单位吨,取值[0 – 200]吨,会严格按照填写数字进行限行规避,请按照车辆真实信息合理填写。 核定载重的含义是可装载货物的最大重量。 |
axle |
车辆轴数 |
仅货车/纯电动货车/插电式混动货车类型生效 单位个,取值[0 –50]个,会严格按照填写数字进行限行规避,请按照车辆真实信息合理填写。 |
距离测量
- 距离测量API URL:
URL |
https://restapi.amap.com/v3/distance?parameters |
请求方式 |
GET |
parameters 代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。
- 请求参数
参数名 |
含义 |
规则说明 |
是否必须 |
缺省值 |
|
---|---|---|---|---|---|
key |
请求服务权限标识 |
用户在高德地图官网申请Web服务API类型KEY |
必填 |
无 |
|
origins |
出发点 |
支持100个坐标对,坐标对见用“| ”分隔;经度和纬度用”,”分隔 |
必填 |
无 |
|
destination |
目的地 |
规则: lon,lat(经度,纬度), “,”分割 如117.500244, 40.417801 经纬度小数点不超过6位 |
必填 |
无 |
|
type |
路径计算的方式和方法 |
0:直线距离 1:驾车导航距离(仅支持国内坐标)。 必须指出,当为1时会考虑路况,故在不同时间请求返回结果可能不同。 此策略和驾车路径规划接口的 strategy=0策略基本一致,策略为“ 速度优先,此路线不一定距离最短 ” 由于算法差异,无法保证距离测量结果与路径规划结果完全一致。若需要实现高德地图客户端效果,可以考虑使用驾车路径规划接口 3:步行规划距离(仅支持5km之间的距离) |
可选 |
1 |
|
sig |
数字签名 |
可选 |
无 |
||
output |
返回数据格式类型 |
可选值:JSON,XML |
可选 |
JSON |
|
callback |
回调函数 |
callback值是用户定义的函数名称,此参数只在output=JSON时有效 |
可选 |
无 |
- 服务示例
https://restapi.amap.com/v3/distance?origins=116.481028,39.989643|114.481028,39.989643|115.481028,39.989643&destination=114.465302,40.004717&output=xml&key=<用户的key>
参数 |
值 |
备注 |
必选 |
---|---|---|---|
origins |
出发点 支持100个坐标对(公交仅支持20个),坐标对见用“| ”分隔;经度和纬度用”,”分隔 |
是 |
|
destination |
目的地 规则: lon,lat(经度,纬度), “,”分割 如117.500244, 40.417801 经纬度小数点不超过6位 |
是 |
|
type |
此参数需要输入路径计算的方式和方法 |
否 |
- 返回结果参数说明
距离测量的响应结果的格式由请求参数output指定。
名称 |
说明 |
||
---|---|---|---|
status |
返回结果状态值,值为0或1,0表示请求失败;1表示请求成功 |
||
info |
返回状态说明,status为0时,info返回错误原因;否则返回“OK”。详情参阅info状态表 |
||
results |
距离信息列表 |
||
result |
距离信息 |
||
origin_id |
起点坐标,起点坐标序列号(从1开始) |
||
dest_id |
终点坐标,终点坐标序列号(从1开始) |
||
distance |
路径距离,单位:米 |
||
duration |
预计行驶时间,单位:秒 |
||
info |
仅在出错的时候显示该字段。大部分显示“未知错误” 由于此接口支持批量请求,建议不论批量与否用此字段判断请求是否成功 |
||
code |
仅在出错的时候显示此字段。 在驾车模式下: 1,指定地点之间没有可以行车的道路 2,起点/终点 距离所有道路均距离过远(例如在海洋/矿业) 3,起点/终点不在中国境内 |