Giúp người dùng tìm kiếm địa điểm mà không cần nhập đầy đủ từ khóa.
Endpoint
https://maps.track-asia.com/api/v2/place/autocomplete/{outputFormat}
outputFormat
outputFormat | Mô tả |
---|---|
json (khuyến nghị) | định dạng JSON |
xml | định dạng XML |
Tham số
Tham số | Giá trị | Mô tả | Ví dụ |
---|---|---|---|
input | Chuỗi (bắt buộc) | Chuỗi đầu vào cần tự động hoàn thành. Có thể là địa chỉ chưa đầy đủ, tên địa điểm, hoặc bất kỳ chuỗi nào cần tìm kiếm | Toa nha BW |
key | Chuỗi (bắt buộc) | Khóa API | public_key |
bounds | {vĩ độ},{kinh độ};{vĩ độ},{kinh độ} | Vùng giới hạn không gian để ưu tiên kết quả tìm kiếm. Tham số này chỉ định hướng, không bắt buộc kết quả phải nằm trong vùng này | 21.6463420,104.8429379;21.7503187,104.9330227 |
size | Số nguyên | Số lượng kết quả tối đa cần trả về | 5 |
location | {vĩ độ},{kinh độ} | Tọa độ địa điểm để tìm địa chỉ gần nhất có thể đọc được bằng tiếng người dùng | 10.7952219,106.7217912 |
Mã ví dụ
https://maps.track-asia.com/api/v2/place/autocomplete/json?input=Toa nha BW&bounds=21.6463420,104.8429379;21.7503187,104.9330227&size=2&key=public_key
https://maps.track-asia.com/api/v2/place/autocomplete/xml?input=Toa nha BW&bounds=21.6463420,104.8429379;21.7503187,104.9330227&key=public_key
Phản hồi
JSON Phản hồi
Phản hồi là một đối tượng JSON với cấu trúc như sau:
status
: Chuỗi trạng thái (ví dụ: "OK").predictions
: Mảng các đối tượng gợi ý. Mỗi đối tượng gồm:place_id
: Định danh duy nhất cho địa điểm.reference
: Tham chiếu cho địa điểm (có thể trùng vớiplace_id
).name
: Tên địa điểm.sublabel
: Địa chỉ hoặc thông tin bổ sung.description
: Mô tả đầy đủ về địa điểm.matched_substrings
: Mảng các đối tượng thể hiện vị trí khớp với chuỗi nhập vào.structured_formatting
: Đối tượng gồmmain_text
,main_text_matched_substrings
, vàsecondary_text
để hiển thị.terms
: Mảng các đối tượng vớioffset
vàvalue
cho từng thành phần kết quả.geometry
: Đối tượng vớilocation
(lat/lng),location_type
, vàviewport
(northeast/southwest).plus_code
: Đối tượng vớicompound_code
vàglobal_code
.types
: Mảng các phân loại của địa điểm.
``
XML Phản hồi
Phản hồi XML có cấu trúc tương tự, các trường sẽ là các thẻ XML tương ứng với các trường JSON ở trên. Một số khác biệt:
- Kết quả XML được bọc trong phần tử gốc
<AutocompletionResponse>
. - Các mảng trong JSON (như
predictions
,terms
) sẽ là các phần tử lặp lại trong XML (như<prediction>
,<term>
). - Các trường rỗng được thể hiện bằng mảng rỗng trong JSON, nhưng sẽ không có phần tử nào trong XML.
Status
Status | Mô tả |
---|---|
OK | cho biết API request đã thành công. |
ZERO_RESULTS | chỉ ra rằng tìm kiếm đã thành công nhưng không trả lại kết quả. Điều này có thể xảy ra nếu tìm kiếm được thông qua một giới hạn ở một vị trí xa. |
Các bước tiếp theo
- Thử API playground