Autocomplete

Autocomplete 3.0 API cho phép bạn gắn tính năng gợi ý địa chỉ vào ứng dụng. API giúp người dùng tìm và chọn nhanh một địa điểm trong kho dữ liệu lớn, bằng cách gợi ý các kết quả khớp ngay khi họ đang gõ.

API dựa trên mô hình học máy phân tích nội dung người dùng gõ và gợi ý kết quả theo ngữ cảnh tìm kiếm. Mô hình được huấn luyện từ nhiều nguồn: dữ liệu địa lý, lịch sử tìm kiếm và các thông tin ngữ cảnh khác.

Quan trọng

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

Playground

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

URL

https://maps.vietmap.vn/api/autocomplete/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
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
circle_center	string	không	Tọa độ tâm (lat,lng) position của vùng cần tìm	10.758867,106.6755666
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
focus	number	không	Tọa độ tâm của vùng tìm kiếm.	10.758867,106.675566
text	string	có	Nội dung người dùng nhập	Cong ty
layers	string	không	Giới hạn theo loại dữ liệu: POI,ADDRESS,VILLAGE,WARD,DIST,CITY,STREET	POI

Ví dụ

Đầu vào

https://maps.vietmap.vn/api/autocomplete/v3?apikey={your-apikey}&text=197 tran phu&focus=10.75887508,106.67538868

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:ADDRESS:8AD49CFA2E0C300A",
        "distance": 0.06911172534949989,
        "address": "Phường 4, Quận 5, Thành Phố Hồ Chí Minh",
        "name": "197 Đường Trần Phú",
        "display": "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": [],
        "entry_points": []
    },
    {
        "ref_id": "vm:ADDRESS:A4DFA42575DEA254",
        "distance": 23.712993485603697,
        "address": "Phường Chánh Nghĩa, Thành Phố Thủ Dầu Một, Tỉnh Bình Dương",
        "name": "197 Đường Trần Phú",
        "display": "197 Đường Trần Phú Phường Chánh Nghĩa, Thành Phố Thủ Dầu Một, Tỉnh Bình Dương",
        "boundaries": [
            {
                "type": 2,
                "id": 327959,
                "name": "Chánh Nghĩa",
                "prefix": "Phường",
                "full_name": "Phường Chánh Nghĩa"
            },
            {
                "type": 1,
                "id": 279,
                "name": "Thủ Dầu Một",
                "prefix": "Thành Phố",
                "full_name": "Thành Phố Thủ Dầu Một"
            },
            {
                "type": 0,
                "id": 23,
                "name": "Bình Dương",
                "prefix": "Tỉnh",
                "full_name": "Tỉnh Bình Dương"
            }
        ],
        "categories": [],
        "entry_points": []
    }
]

Mô tả phản hồi

Autocomplete 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	int	Cấp hành chính (0 = tỉnh/thành, 1 = quận/huyện, 2 = phường/xã)
id	int	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