# Geocoding API — Vietmap API Playground

> Chuyển đổi địa chỉ thành tọa độ với Vietmap Geocode API.

Geocoding API chuyển một địa chỉ dạng chữ thành tọa độ. Phiên bản v4 hiểu cả địa chỉ theo đơn vị hành chính mới sau sáp nhập lẫn địa chỉ cũ, nhận bộ lọc tỉnh, quận, phường, vòng tròn và danh mục, và trả kết quả kèm địa chỉ đã chuẩn hóa. Đây là bước đầu tiên khi cần đưa danh sách địa chỉ khách hàng lên bản đồ hay chuyển sang các API tìm đường, tối ưu lộ trình.

Dùng để làm gì:
- Đưa danh sách đơn hàng, khách hàng lên bản đồ.
- Lấy tọa độ cho Route, Matrix, TSP, VRP.
- Kiểm tra địa chỉ có tồn tại trước khi tạo đơn.
- Phân vùng khách theo tỉnh, phường.

- Trang tương tác: https://tools.vietmap.vn/playground/geocode
- Endpoint: `GET /api/search/v4` trên `https://maps.vietmap.vn`
- Tài liệu chính thức: https://maps.vietmap.vn/docs/map-api/geocode-version/geocode-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

### cURL

```bash
curl 'https://maps.vietmap.vn/api/search/v4?apikey=YOUR_API_KEY&text=197+Tr%E1%BA%A7n+Ph%C3%BA&admin_new=true&display_type=6'
```

### 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],
  ["text", "197 Trần Phú"],
  ["admin_new", "true"],
  ["display_type", "6"],
]);

const response = await fetch(`https://maps.vietmap.vn/api/search/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),
    ("text", "197 Trần Phú"),
    ("admin_new", "true"),
    ("display_type", "6"),
]

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

### URL

```text
https://maps.vietmap.vn/api/search/v4?apikey=YOUR_API_KEY&text=197+Tr%E1%BA%A7n+Ph%C3%BA&admin_new=true&display_type=6
```

## 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 Geocoding (Search) 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/geocode-version/geocode-v4/

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

GET https://maps.vietmap.vn/api/search/v4?apikey=YOUR_API_KEY&text=197+Tr%E1%BA%A7n+Ph%C3%BA&admin_new=true&display_type=6

Tham số đang dùng:
- text = 197 Trần Phú
- admin_new = true
- display_type = 6

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/geocode?text=197+Tr%E1%BA%A7n+Ph%C3%BA&display_type=6
