查看演示 (opens new window)

路径规划Api

接口地址:/route

请求方式:GET

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	说明	请求类型	是否必须	数据类型	备注
point	第一个点	query	true	string	多个点按照顺序进行传参
point	第二个点	query	true	string
type	返回结果类型	query	false	string	可选值 json,geojson,默认json
locale	当前的地区	query	false	string	默认值根据web请求的地区来进行识别
elevation	参加高程计算	query	false	string
points_encoded	返回的空间结果集是否进行编码	query	false	string	默认是进行编码
profile	导航的类型	query	true	string
snap_prevention	避开	query	false	string	参数详情参见
details	返回的细节信息	query	false	string	参数详情参见

响应示例:

{
	"hints": {
		"visited_nodes.sum": 14,
		"访问的总节点数量": 14,
		"visited_nodes.average": 14.0,
		"平均访问的节点": 14.0
	},
	"info": {
		"copyrights": [
			"gishub",
			"北京图创时代科技有限公司2019-2025 路径规划服务v13.11"
		],
		"took": 93
	},
	"paths": [{ // 这是一个数组，可能规划出来两条道路
		"distance": 2025735.346,    //该规划道路的总距离 单位米
		"weight": 104180.674617,  // 成本
		"time": 104180668,// 该规划道路的总时间
		"transfers": 0,
		"points_encoded": false, // 表示该空间数据是否编码
		"bbox": [// 当前道路的返回的图层边界
			77.2241,
			36.793045,
			84.338793,
			41.813094
		],
		"points": {// 当前规划方案组成的所有点
			"type": "LineString",
			"coordinates": []  //  点数组
		},
		"instructions": [{  // 一些导航提示语
				"distance": 321407.967, // 行驶距离
				"heading": 41.38,// 高度
				"sign": 0, // 转向代码
				"interval": [  //表示当前的提示语是第0个点到第1565个点
					0,  
					1565
				],
				"text": "继续行驶到 阿勒泰―塔什库尔干|阿塔线|下行",
				"time": 16529552, // 预计行驶时间 单位毫秒
				"street_name": "阿勒泰―塔什库尔干|阿塔线|下行"
			},
		 ///
			{
				"distance": 0.0,
				"sign": 4,
				"last_heading": 249.52311977947355,
				"interval": [
					7535,
					7535
				],
				"text": "终点到达",
				"time": 0,
				"street_name": ""
			}
		],
		"legs": [],
		"details": {
			"gtc_id": [
				[   // 表示第0个点到第1565个点的gic_id   ,所有的details 里面的内容都是这样的组织的
					0,
					1565,
					"1722148553148645376"
				],
				 
				 //......
				[
					7516,
					7535,
					"1722148553488384000"
				]
			],
			"table_id": [
				[
					0,
					7535,
					"t_1722148508001157120"
				]
			],
			"street_name": [
				[
					0,
					1565,
					"阿勒泰―塔什库尔干|阿塔线|下行"
				],
			//......
				[
					7516,
					7535,
					"乌鲁木齐―红其拉甫|乌红线|下行"
				]
			]
		},
		"ascend": 0.0,
		"descend": 0.0,
		"snapped_waypoints": {
			"type": "LineString",
			"coordinates": [
				[
					78.294502,
					39.55078
				],
				[
					84.29585,
					41.800206
				]
			]
		}
	}]
}

postman示范

snap_prevention说明 可选参数，用于避免捕捉到特定的道路类别或道路环境。
当前支持的值：“高速公路”、“主干道”、“渡轮”、“隧道”、“桥梁”。
指定了多个值，如“snap_prevention=ferry”和“snap_pevention=高速公路”

details说明 您可以请求路线的其他详细信息：
“average_speed”、“street_name”、“edge_id”、“road_class”、“road_environment”、“max_speed”和“time”
（并查看在“graph.encoded_values”中配置了哪些其他值）。
指定了多个值，如“details=average_peed&details=time”。
一个详细信息段的返回格式为“[fromRef，toRef，value]”。
“ref”引用了响应的要点。如果某个细节段不存在属性，则值也可以为“null”curbside