Autocomplete APIs

Cho phép ứng dụng của bạn đề xuất địa điểm khi người dùng đang nhập truy vấn địa điểm.

Mô tả

Endpoints /autocomplete giúp người dùng nhận đề xuất các địa điểm trong thời gian thực khi người dùng đang nhập truy vấn địa điểm, địa chỉ. Tính năng này giúp cho người dùng của bạn nhập các địa điểm, địa chỉ nhanh hơn mà không cần phải nhập đầy đủ địa điểm vào ô truy vấn. Ngoài ra bạn có thể tăng độ chính xác của các đề xuất tìm kiếm bằng cách giới hạn trong một vùng tìm kiếm nhất định để đem lại các đề xuất chính xác, mang tính địa phương hóa cao.

Để tạo một truy vấn cho Autocomplete, bạn cần một tham số text, tham số này là tất cả các ký tự mà người dùng đã nhập vào ô truy vấn trong ứng dụng của bạn. Để giới hạn đề xuất các địa điểm trong một vùng nhất định bạn có thể thêm vào các tham số để giới hạn trong vùng địa lý đó, việc này giúp cho người dùng nhận được các đề xuất mang tính địa phương, phù hợp với mong muốn người dùng hơn.

mẹo

Hãy sử dụng Enterprise Dashboard hoặc hướng dẫn API Key để tạo API Key và trải nghiệm miễn phí!

thông tin

API Autocomplete của Openmap.vn cho phép trả về định dạng của nền tảng OSM hoặc Google.

Base URL

Mã URL chung cho tất các yêu cầu API: https://mapapis.openmap.vn/v1

Endpoint

GET /autocomplete

Định dạng Google

Tham chiếu API

Tham số	Loại	Bắt buộc	Mặc định	Mô tả	Ví dụ
input	string	có	không	Từ khóa tìm kiếm của bạn	Công Ty TNHH Công Nghệ 44+
location	string	không	không	Vị trí để ưu tiên tìm kiếm	21.03279,105.78788
origin	string	không	không	Điểm xuất phát để tính khoảng cách đường thẳng đến điểm đích (được trả về dưới dạng distance_meters). Phải được chỉ định dưới dạng vĩ độ,kinh độ	21.03279,105.78788
radius	number	không	50	Giới hạn tìm kiếm trong bán kính từ vị trí chỉ định (đơn vị: km)	10
sessiontoken	string	không	không	Mã UUID v4 để nhóm nhiều yêu cầu Autocomplete trong một phiên	576e6543-fbc8-422c-9aad-9884c97df128

Ví dụ

Yêu cầu:

GET /autocomplete?text=Công ty TNHH Công Nghệ 44+&location=21.03279,105.78788&radius=50

Trả về:

{
  "predictions": [
    {
      "description": "Công Ty TNHH Công Nghệ 44+, 12 Ngõ 1 Dịch Vọng Hậu, phường Dịch Vọng Hậu, quận Cầu Giấy, thành phố Hà Nội",
      "matched_substrings": [
        {
          "length": 2,
          "offset": 23
        }
      ],
      "place_id": "BFMhbS2hGqAeWlxPGNjnClF6aYQk3F1-nXJxZZjAncYpdqHZSNzpfi0W3RCU",
      "structured_formatting": {
        "main_text": "Công Ty TNHH Công Nghệ 44+",
        "main_text_matched_substrings": [
          {
            "length": 2,
            "offset": 23
          }
        ],
        "secondary_text": "12 Ngõ 1 Dịch Vọng Hậu, phường Dịch Vọng Hậu, quận Cầu Giấy, thành phố Hà Nội",
        "secondary_text_matched_substrings": [

        ]
      },
      "terms": [
        {
          "offset": 0,
          "value": "Công Ty TNHH Công Nghệ 44+"
        },
        {
          "offset": 31,
          "value": "12 Ngõ 1 Dịch Vọng Hậu"
        },
        {
          "offset": 62,
          "value": "phường Dịch Vọng Hậu"
        },
        {
          "offset": 93,
          "value": "quận Cầu Giấy"
        },
        {
          "offset": 114,
          "value": "thành phố Hà Nội"
        }
      ],
      "types": [
        "corporate_office"
      ],
      "distance_meters": null
    }
  ],
  "status": "OK"
}

Định dạng OSM

Tham chiếu API

Tham số	Loại	Bắt buộc	Mặc định	Mô tả	Ví dụ
text	string	có	không	Từ khóa tìm kiếm của bạn	Công Ty TNHH Công Nghệ 44+
boundary.circle.lat	số thực	không	không	Vĩ độ	21.03279
boundary.circle.lon	số thực	không	không	Kinh độ	105.78788
boundary.circle.radius	number	không	50	Giới hạn tìm kiếm trong bán kính từ vị trí chỉ định (đơn vị: km)	10
sessiontoken	string	không	không	Mã UUID v4 để nhóm nhiều yêu cầu Autocomplete trong một phiên	576e6543-fbc8-422c-9aad-9884c97df128

Ví dụ

Yêu cầu:

GET /autocomplete?text=Công ty TNHH Công Nghệ 44+&size=1

Trả về:

{
  "errors": null,
  "features": [
    {
      "type": "Feature",
      "properties": {
        "name": "Công Ty TNHH Công Nghệ 44+",
        "housenumber": null,
        "street": null,
        "short_address": "12 Ngõ 1 Dịch Vọng Hậu",
        "postalcode": null,
        "label": "Công Ty TNHH Công Nghệ 44+, 12 Ngõ 1 Dịch Vọng Hậu, phường Dịch Vọng Hậu, quận Cầu Giấy, thành phố Hà Nội",
        "country": "Việt Nam",
        "country_code": "VN",
        "category": [
          "corporate_office"
        ],
        "website": null,
        "opening_hours": null,
        "phone": null,
        "region": "thành phố Hà Nội",
        "county": "quận Cầu Giấy",
        "locality": "phường Dịch Vọng Hậu",
        "distance": null,
        "id": "BFMhbS2hGqAeWlxPGNjnClF6aYQk3F1-nXJxZZjAncYpdqHZSNzpfi0W3RCU",
        "continent": "Asia",
        "source": "openmapvn"
      }
    }
  ],
  "bbox": [],
  "type": "FeatureCollection"
}