Geocode

Geocode phiên bản 3.0

Geocode 3.0 API giúp bạn gắn chức năng tìm kiếm địa chỉ vào ứng dụng với hiệu năng tối ưu. Bản này dùng thuật toán tìm kiếm thông minh để trả kết quả vừa chính xác vừa nhanh.

Quan trọng

Chúng tôi khuyên dùng Geocode v4 API cho tích hợp mới. Geocode v3 API sẽ ngừng hỗ trợ trong tương lai.

Playground

Bạn có thể thử Geocode API trên Playground.

URL

https://maps.vietmap.vn/api/search/v3?apikey={your-apikey}&text={text}&focus={lat,long}

Method

GET

Tham số

Tham số	Kiểu	Bắt buộc	Mô tả	Ví dụ
apikey	string	có	API key VIETMAP cấp cho tài khoản của bạn. Đăng ký tại đây
text	string	có	Nội dung người dùng nhập	Công Ty Cổ Phần Ứng Dụng Bản Đồ Việt
focus	string	không	GPS cordinates	10.759540242000032, 106.67660114000005
layers	string	không	Giới hạn theo loại dữ liệu: POI,ADDRESS,VILLAGE,WARD,DIST,CITY,STREET	POI
circle_center	number	không	Tọa độ tâm(lat/lng) position của vùng cần tìm	10.758867051669924,106.6755666901197
circle_radius	number	không	Bán kính vùng tìm kiếm (in meters)	200
cats	string	không	Danh sách nhóm địa điểm (POI). Xem tại POI Categories	1002-1
cityId	number	không	Mỗi tỉnh/thành có một ID riêng, dùng để lọc kết quả tìm kiếm	12
distId	number	không	Mỗi quận/huyện có một ID riêng, dùng để lọc kết quả tìm kiếm	1292
wardId	number	không	Mỗi phường/xã có một ID riêng, dùng để lọc kết quả tìm kiếm	984332

Ví dụ

Đầu vào

https://maps.vietmap.vn/api/search/v3?apikey={your-apikey}&focus=10.75887508,106.67538868&text=Công Ty Cổ Phần Ứng Dụng Bản Đồ Việt,HCM

Phản hồi

Cần thông tin chi tiết của địa điểm thì bạn dùng VIETMAP Place API

[
    {
        "ref_id": "vm:POI:7057AB748BFD685B",
        "distance": 0.069199492010845,
        "address": "197 Đường Trần Phú,Phường 4,Quận 5,Thành Phố Hồ Chí Minh",
        "name": "Công Ty Cổ Phần Ứng Dụng Bản Đồ Việt",
        "display": "Công Ty Cổ Phần Ứng Dụng Bản Đồ Việt 197 Đường Trần Phú,Phường 4,Quận 5,Thành Phố Hồ Chí Minh",
        "boundaries": [
            {
                "type": 2,
                "id": 656652,
                "name": "4",
                "prefix": "Phường",
                "full_name": "Phường 4"
            },
            {
                "type": 1,
                "id": 1292,
                "name": "5",
                "prefix": "Quận",
                "full_name": "Quận 5"
            },
            {
                "type": 0,
                "id": 12,
                "name": "Hồ Chí Minh",
                "prefix": "Thành Phố",
                "full_name": "Thành Phố Hồ Chí Minh"
            }
        ],
        "categories": [
            "6001"
        ],
        "entry_points": []
    },
    {
        "ref_id": "vm:POI:37B6A20D8D9190CD",
        "distance": 0.06445065459645513,
        "address": "199 Đường Trần Phú,Phường 4,Quận 5,Thành Phố Hồ Chí Minh",
        "name": "Công Ty Cổ Phần Ứng Dụng Bản Đồ Việt Trung Tâm Bảo Hành",
        "display": "Công Ty Cổ Phần Ứng Dụng Bản Đồ Việt Trung Tâm Bảo Hành 199 Đường Trần Phú,Phường 4,Quận 5,Thành Phố Hồ Chí Minh",
        "boundaries": [
            {
                "type": 2,
                "id": 656652,
                "name": "4",
                "prefix": "Phường",
                "full_name": "Phường 4"
            },
            {
                "type": 1,
                "id": 1292,
                "name": "5",
                "prefix": "Quận",
                "full_name": "Quận 5"
            },
            {
                "type": 0,
                "id": 12,
                "name": "Hồ Chí Minh",
                "prefix": "Thành Phố",
                "full_name": "Thành Phố Hồ Chí Minh"
            }
        ],
        "categories": [
            "6001"
        ],
        "entry_points": []
    }
]

Mô tả phản hồi

Geocode API trả về một list chứa tối đa 10 địa điểm.

Trường	Kiểu	Mô tả
ref_id	string	Mã tham chiếu của địa điểm (POI), using for get detail info from VIETMAP Place API
address	string	Địa chỉ đầy đủ gồm đường, phường/xã, quận/huyện và tỉnh/thành
name	string	Tên địa điểm (POI)
display	string	Tên hiển thị, chứa đầy đủ thông tin địa chỉ của địa điểm
boundaries	array	Mảng các đơn vị hành chính của địa chỉ, xếp từ cấp nhỏ đến cấp lớn (ward, district, city)
categories	array	Mảng các nhóm mà địa điểm thuộc về
entry_points	array	Mảng các lối vào của địa điểm. Chỉ có ở một số địa điểm đặc biệt như sân bay, khách sạn...

Với mảng boundaries:

Trường con	Kiểu	Mô tả
type	integer	Cấp hành chính (0 = tỉnh/thành, 1 = quận/huyện, 2 = phường/xã)
id	integer	Mã định danh của đơn vị hành chính
name	string	Tên đơn vị hành chính, chưa kèm tiền tố
prefix	string	Tiền tố cấp hành chính. Ví dụ: Phường, Quận, Thành Phố
full_name	string	Tên đầy đủ gồm cả tiền tố. Ví dụ: Phường 9

Với mảng entry_points:

Trường con	Kiểu	Mô tả
ref_id	string	Mã tham chiếu của địa điểm (POI)
name	string	Tên địa điểm (POI)

Cần thông tin chi tiết của lối vào thì bạn dùng VIETMAP Place API