# Route API — Vietmap API Playground

> Tìm đường đi giữa các điểm với Vietmap Route API.

Route API là API chỉ đường của Vietmap: tìm đường đi qua hai điểm trở lên theo đúng thứ tự cho ô tô, xe máy, xe tải, xe đạp hoặc đi bộ. Kết quả gồm quãng đường, thời gian, đường đi để vẽ lên bản đồ và chỉ dẫn từng chặng. Phiên bản v4 trả thêm phí đường bộ và mức độ ùn tắc trên từng đoạn, có thể tránh trạm thu phí, đặt giờ khởi hành, hướng xuất phát và tải trọng xe tải, kèm các tuyến thay thế.

Dùng để làm gì:
- Ước tính thời gian giao hàng, thời gian đến nơi.
- Chỉ đường trong app tài xế, app đi lại.
- Tính phí vận chuyển theo quãng đường thực tế và phí cầu đường.
- So sánh tuyến cho xe máy, ô tô và xe tải.

- Trang tương tác: https://tools.vietmap.vn/playground/route
- Endpoint: `GET /api/route/v4` trên `https://maps.vietmap.vn` (trang có tuỳ chọn chuyển sang v3 và api-version=1.1)
- Tài liệu chính thức: https://maps.vietmap.vn/docs/map-api/route-version/route-v4/
- API key: mọi request cần tham số `apikey`. Code mẫu dùng `YOUR_API_KEY` làm chỗ giữ key — khi tích hợp, đọc key từ biến môi trường (ví dụ `VIETMAP_API_KEY`). Lấy key tại https://maps.vietmap.vn/console-v2/consumers
- Mã lỗi: `401` sai API key · `403` key bị giới hạn domain/IP · `423` API chưa bật cho consumer của key, hoặc hết credit (phản hồi có "exceeded credit") · `429` vượt giới hạn tần suất.

## Code mẫu

_Đây là request ví dụ với tham số mẫu; mở trang tương tác để đổi tham số và chạy thật._

### cURL

```bash
curl 'https://maps.vietmap.vn/api/route/v4?apikey=YOUR_API_KEY&point=21.0285,105.8542&point=21.0368,105.8346&points_encoded=false&vehicle=car&alternative=false&annotations=toll,congestion,congestion_distance'
```

### JavaScript

```javascript
// Khi đưa vào sản phẩm, đọc key từ biến môi trường thay vì ghi cứng.
const API_KEY = "YOUR_API_KEY";

const params = new URLSearchParams([
  ["apikey", API_KEY],
  ["point", "21.0285,105.8542"],
  ["point", "21.0368,105.8346"],
  ["points_encoded", "false"],
  ["vehicle", "car"],
  ["alternative", "false"],
  ["annotations", "toll,congestion,congestion_distance"],
]);

const response = await fetch(`https://maps.vietmap.vn/api/route/v4?${params}`);
if (!response.ok) {
  throw new Error(`Vietmap ${response.status}: ${await response.text()}`);
}
const data = await response.json();
console.log(data);
```

### Python

```python
import requests

# Khi đưa vào sản phẩm, đọc key từ biến môi trường thay vì ghi cứng.
API_KEY = "YOUR_API_KEY"

params = [
    ("apikey", API_KEY),
    ("point", "21.0285,105.8542"),
    ("point", "21.0368,105.8346"),
    ("points_encoded", "false"),
    ("vehicle", "car"),
    ("alternative", "false"),
    ("annotations", "toll,congestion,congestion_distance"),
]

response = requests.get("https://maps.vietmap.vn/api/route/v4", params=params, timeout=30)
response.raise_for_status()
print(response.json())
```

### URL

```text
https://maps.vietmap.vn/api/route/v4?apikey=YOUR_API_KEY&point=21.0285,105.8542&point=21.0368,105.8346&points_encoded=false&vehicle=car&alternative=false&annotations=toll,congestion,congestion_distance
```

## AI prompt

Prompt soạn sẵn để giao cho trợ lý lập trình (ChatGPT, Claude, Copilot…) viết code tích hợp API này:

````text
Tôi cần tích hợp Route API v4 của Vietmap vào ứng dụng của mình.

Tài liệu chính thức: https://maps.vietmap.vn/docs/map-api/route-version/route-v4/

Đây là một request mẫu đã chạy được trên Vietmap API Playground:

GET https://maps.vietmap.vn/api/route/v4?apikey=YOUR_API_KEY&point=21.0285,105.8542&point=21.0368,105.8346&points_encoded=false&vehicle=car&alternative=false&annotations=toll,congestion,congestion_distance

Tham số đang dùng:
- point = 21.0285,105.8542
- point = 21.0368,105.8346
- points_encoded = false
- vehicle = car
- alternative = false
- annotations = toll,congestion,congestion_distance

Hãy viết code bằng [ngôn ngữ / framework của tôi] để gọi API này, với các yêu cầu:
1. Đọc API key từ biến môi trường VIETMAP_API_KEY, không ghi cứng trong code.
2. Truyền tham số qua query string đúng như request mẫu; tham số lặp lại (như `point`) phải giữ nguyên thứ tự.
3. Xử lý lỗi theo mã HTTP của Vietmap:
   - 401: API key sai hoặc đã bị thu hồi.
   - 403: key bị giới hạn theo domain / IP không khớp.
   - 423: API chưa được bật cho consumer của key, HOẶC tài khoản hết credit — phân biệt bằng nội dung phản hồi (có cụm "exceeded credit" là hết credit).
   - 429: vượt giới hạn tần suất — thử lại với backoff tăng dần.
4. Đặt timeout cho request, và định nghĩa kiểu dữ liệu (type / interface / dataclass) cho phản hồi.

Nếu không chắc tên một trường, tra trong tài liệu ở link trên thay vì đoán.
````

## Mở lại đúng request này trong Playground

https://tools.vietmap.vn/playground/route?point=21.0285,105.8542&point=21.0368,105.8346&version=v4&vehicle=car&annotations=toll,congestion,congestion_distance
