Maps API Document

Mô tả

Tài liệu này với mục đích hướng dẫn việc sử dụng các chức năng của Vietmap Map API. Map API dùng để tìm kiếm, xử lý các thông tin trên bản đồ một cách thuận tiện và dễ dàng nhất. Tuy nhiên để sử dụng được nó không hề đơn giản, bạn phải rành Javascript. Nếu viết ứng dụng thực tế thì bạn cần phải kết hợp code ngôn ngữ server như PHP để xử lý.

Maps API

Các chức năng chính Vietmap Maps API sử dụng gồm:

  • Tile map: Cung cấp bản đồ dưới dạng ảnh trên web, app mobile (Ios, Android).
  • Routing: Tìm đường đi tối ưu nhất giữa 2 hoặc hơn 2 điểm.
  • Geocoding: Hỗ trợ autocomplete kết quả tìm kiếm và xuất ra chuỗi địa chỉ đúng nhất với kết quả.
  • Reverse Geocoding: Từ tọa độ nội suy ra địa chỉ tại điểm đó.

API key

API Key là code được truyền bởi các chương trình máy tính gọi API để xác định chương trình gọi, nhà phát triển hoặc người dùng của nó đến trang Web. Các API Key được sử dụng để theo dõi và kiểm soát cách sử dụng API, ví dụ để ngăn chặn việc sử dụng độc hại hoặc lạm dụng API (có thể được xác định theo điều khoản dịch vụ).

API Key thường hoạt động như một mã định danh duy nhất và mã thông báo bí mật để xác thực và thường sẽ có một bộ quyền truy cập trên API được liên kết với nó.

Các API Key có thể dựa trên hệ thống định danh duy nhất toàn cầu (UUID) để đảm bảo chúng sẽ là duy nhất cho mỗi người dùng.

Vui lòng liên hệ Vietmap để được cung cấp apikey. Liên hệ: 19000801.

Ghi chú: trong tương lai sẽ có đường link để đăng ký.

Chức năng

Smiley face

Tile map

Mô tả: Cung cấp raster tile từ dữ liệu của Vietmap

API:

GET{domain}/{z}/{x}/{y}.png?apikey={apikey}

Inputs:

Tên Mô tả Kiểu Yêu cầu Mặc định
z Độ zoom int yes
x Tọa độ ô lưới ảnh trên trục kinh tuyến vĩ tuyến int yes
y Tọa độ ảnh thuộc ô lưới (x) int yes
apikey apikey string yes

Sample:

https://maps.vietmap.vn/tm/16/52191/30794.png?apikey=

Outputs: Bản đồ nền

Smiley face

Routing

Routing 2 điểm

Mô tả: Cung cấp thông tin đường đi nhanh nhất giữa 2 điểm

API:

GET{domain}?point={x}%2C{y}&point={x}%2C{y}&{type}&{locale}&{vehicle}&{weighting}&{elevation}&apikey=

Inputs:

Tên Mô tả Kiểu Yêu cầu Mặc định
point Địa điểm Array of strings yes
x Tọa độ điểm bắt đầu double yes
y Tọa độ điểm kết thúc double yes
type kiểu string yes
local Tọa độ ô lưới ảnh trên trục kinh tuyến vĩ tuyến string yes
vehicle Phương tiện string yes
weighting Trọng số string yes
elevation Cao độ string yes
apikey apikey

Sample:

https://maps.vietmap.vn/api/route?point=10.788117,106.621284 &point=10.769905,106.700621&type=json&locale=en-US&vehicle= car&weighting=fastest&elevation=false&apikey=

Outputs:

Line, khoảng cách, thời gian, hướng đi.

Routing hơn 2 điểm

Mô tả: Cung cấp thông tin tối ưu đường đi nhanh nhất qua các điểm

API:

GET{domain}?point={x},{y}&point={x},{y}&point={x},{y}&{type}&{locale}&{vehicle}&{weighting}&{elevation}&apikey=

Inputs:

Tên Mô tả Kiểu Yêu cầu Mặc định
point Địa điểm Array of strings yes
x Tọa độ điểm bắt đầu double yes
y Tọa độ điểm kết thúc double yes
type kiểu string yes
local Tọa độ ô lưới ảnh trên trục kinh tuyến vĩ tuyến string yes
vehicle Phương tiện string yes
weighting Trọng số string yes
elevation Cao độ string yes
apikey apikey

Sample:

https://maps.vietmap.vn/api/route?point=10.776861%2C106.690657 &point=10.774268,106.68613&point=10.773615,106.685486&point =10.770189,106.684381&type=json&locale=en-US&vehicle=car &weighting=fastest&elevation=false&apikey=

Outputs:

Line, khoảng cách, thời gian, hướng đi.

Smiley face

Geocoding

Mô tả:Geocoding cho phép tìm kiếm vị trí từ thông tin tên của cửa hàng, địa chỉ nhà. Đồng thời cũng cho phép 1 số các tùy chọn như tìm kiếm trong 1 vùng, tìm trong 1 bán kính cho trước.

API:

GET{domain}/api/search?text={text}&size={}

Inputs:

Tên Mô tả Kiểu Yêu cầu Mặc định
text Địa điểm string yes none
size Số lượng kết quả chính xác nhất show trong 1 lần tìm kiếm int yes

Sample:

https://maps.vietmap.vn/api/search?text=193 Trần & size=10&apikey= &

Outputs:

Tọa độ x,y của địa điểm liên quan địa điểm bạn tìm kiếm

Sample tìm kiếm địa chỉ

//maps.vietmap.vn/api/search?text=197&size=10&apikey=

Smiley face

Autocomplete

Mô tả: Autocomplete giúp cho ra các kết quả chính xác nhất với thông tin bạn đang search. Hỗ trợ tìm kiếm nhanh và hiệu quả hơn.

API:

GET{domain}/api/autocomplete?text={str}&size={int}

Inputs:

Tên Mô tả Kiểu Yêu cầu Mặc định
text Địa điểm string yes none
size Số lượng kết quả chính xác nhất show trong 1 lần tìm kiếm int yes

Sample:

https://maps.vietmap.vn/api/autocomplete?text=197&size=10&apikey=

Outputs:

Output cho ra nhiều chuỗi có kết quả chính xác với thông tin đang tìm kiếm

Smiley face

Reverse Geocoding

Mô tả:Reverse Geocoding cho phép từ tọa độ x,y nội suy ra địa chỉ tại điểm đó.

API:

GET{domain}/api/reverse?lat={x}&lon={y}&size=10

Inputs:

Tên Mô tả Kiểu Yêu cầu Mặc định
lat Tọa độ x tại điểm đánh dấu double yes
lon Tọa độ y tại điểm đánh dấu double yes
size Số lượng kết quả nội suy ra từ tọa độ đã đánh dấu int none

Sample:

https://maps.vietmap.vn/api/reverse?size=10&lat=10.77037920501717&lon=106.68979883193971&apikey=

Outputs:

số nhà/ tên đường/phường/quận