Maps APIs
eKMap PlatformMaps APIsNavigationRoute API

Route API

Route API tìm đường đi nhanh nhất từ vị trí A đến một vị trí B

Bạn có thể tham khảo ví dụ sử dụng Route API với JavaScript

URL

URL: /navigation/route/{profile}/driving/{coordinates}

Method

Method: GET

Parameters:

* tham số yêu cầu.

Tham sốMô tảGiá trị
api_key*Key xác thực để cho gọi dịch vụYOUR_API_KEY
profile*Loại phương tiện di chuyển:
  • car: Đi bằng ô tô
  • bicycle: Đi bằng xe đạp/xe máy
  • foot: Đi bộ
Ví dụ: car
coordinates*Danh sách tọa độ bao gồm kinh độ, vĩ độ. Ít nhất có hai cặp tọa độ.{longitude},{latitude};{longitude},{latitude}
Ví dụ: 105.809,21.0127;105.80925,21.0131
alternativesTìm kiếm các tuyến đường thay thế. Vượt qua một số alternatives=n1 tìm kiếm cho đến n các tuyến đường thay thế.true, false (mặc định)
stepsCác bước lộ trình đã trả lại cho mỗi chặng của tuyến đườngtrue, false (mặc định)
annotationsTrả về siêu dữ liệu bổ sung cho mỗi tọa độ dọc theo hình dạng tuyến đườngtrue, false (mặc định), nodes, distance, duration, datasources, weight, speed
geometriesĐịnh dạng hình học tuyến đường được trả về (ảnh hưởng đến tổng quan và mỗi bước)polyline (mặc định), polyline6, geojson
overviewThêm hình học tổng quan hoặc đầy đủ, đơn giản hóa theo mức thu phóng cao nhất mà nó có thể được hiển thị hoặc không.simplified (mặc định), full, false
continue_straightBuộc tuyến đường tiếp tục đi thẳng tại các điểm giới hạn ở đó ngay cả khi nó sẽ nhanh hơn. Giá trị mặc định tùy thuộc vào hồ sơ.default (mặc định), true, false
waypointsXử lý các tọa độ đầu vào được chỉ ra bởi các chỉ số đã cho dưới dạng điểm tham chiếu trong đối tượng Đối sánh được trả về. Mặc định là coi tất cả các tọa độ đầu vào là điểm tham chiếu.{index};{index};{index}...

Ví dụ Request:

$ curl "https://api.ekgis.vn/navigation/route/car/driving/105.8096567,21.0127234;105.8324778,21.0037716?overview=full&alternatives=false&steps=false&geometries=geojson&api_key={YOUR_API_KEY}"

Response

Trả về đối tượng chỉ đường với các thông tin sau:

  • code: nếu yêu cầu thành công giá trị là Ok hoặc NoRoute nếu không tìm thấy tuyến đường nào
  • waypoints: Mảng các Waypoint đối tượng đại diện cho tất cả các điểm tham chiếu theo thứ tự:
  • routes: Một mảng các Route đối tượng, được sắp xếp theo thứ hạng đề xuất giảm dần. Dữ liệu trả về dạng GeoJSON hoặc polyline tùy vào tham số truyền vào

Ví dụ dữ liệu trả về dạng JSON:

{
	"waypoints": [
		{
			"distance": 0,
			"location": [
				105.809657,
				21.012723
			],
			"name": "Ngõ Láng Trung"
			"hint": "W8xSgF3MUoAmAAAAFAAAALoBAAAAAAAAOD_WQSalWkF7qplDAAAAACYAAAAUAAAAugEAAAAAAACRAgAA-YZOBvOgQAH5hk4G86BAAQgA7wcwuIh5"
		},
		{
			"distance": 1.247456,
			"location": [
				105.832466,
				21.003772
			],
			"name": "Ngõ 41 Đông Tác",
			"hint": "gjtSgKg7UoArAAAAFwAAAMYAAABuAQAAPjqZQU4yIUF7PK9CJ8wiQxUAAAAMAAAAYwAAALcAAACRAgAAEuBOBvx9QAEe4E4G_H1AAQUAPwswuIh5"
		}
	],
	"routes": [
		{
			"distance": 3751.9,
			"duration": 298.6,
			"weight": 325.7,
			"weight_name": "routability",
			"geometry": {
				"type": "LineString",
				"coordinates": [
					[
						105.809657,
						21.012723
					],
					...
					[
						105.832466,
						21.003772
					]
				]
			},
			"legs": [
				{
					"distance": 3751.9,
					"duration": 298.6,
					"weight": 325.7,
					"summary": "",
					"steps": []
				}
			]
		}
	],
	"code": "Ok"
}