Overview
Giới thiệu
eKMap Platform Maps APIs là nền tảng bản đồ eKMap, cung cấp tập các API bản đồ và API truy vấn, phân tích không gian sẵn sàng để sử dụng.
eKMap Platform Maps APIs cung cấp cho bạn các API có sẵn bao gồm:
- Map giúp bạn hiển thị Bản đồ eKMap trên trang web hoặc ứng dụng của bạn.
- GeoCoding giúp bạn có thể xác định thông tin địa chỉ từ tọa độ hoặc có thể xác định vị trí từ địa chỉ mong muốn.
- Location cung cấp các dịch vụ truy vấn thông tin tại một vị trí quan tâm như độ cao, thủy văn, thổ nhưỡng, quy hoạch, …
- Navigation cung cấp các dịch vụ như routing, Isochrone, matrix.
Bạn có thể truy cập địa chỉ Live Map để trải nghiệm các API do eKMap Platform cung cấp
Để hiểu hơn về eKMap Platform vui lòng xem thêm tại đây
Tài liệu này dành cho ai
Tài liệu này được thiết kế cho những người đã quen với các khái niệm về Rest API, giúp bạn nhanh chóng bắt đầu khám phá và xây dựng ứng dụng bản đồ với eKMap Platform.
Đọc tài liệu này
Mỗi đường dẫn API (endpoint) trong tài liệu này được mô tả bằng một số phần:
- Phương thức HTTP. Bao gồm
GET
,POST
,PUT
,DELETE
- Các đường dẫn cơ sở (Hostname). Tất cả các URL được tham chiếu trong tài liệu đều có đường dẫn cơ sở https://api.ekgis.vn. Đường dẫn cơ sở này đặt trước
endpoint
- Đường dẫn điểm cuối. Ví dụ
/directions/{profile}/{coordinates}
- Các thông số bắt buộc (parameters). Các thông số này phải được bao gồm trong một yêu cầu. Trong ví dụ trên,
{profile}
và{coordinates}
là các tham số bắt buộc. - Các thông số tùy chọn. Các tham số này có thể được đưa vào một yêu cầu để tùy chỉnh truy vấn. Tham số truy vấn được thêm vào cuối URL với mã hóa chuỗi truy vấn, các tham số này không yêu cầu bắt buộc
- Khóa API. Mọi yêu cầu dịch vụ do eKMap Platform cung cấp đều yêu cầu một giá trị
api_key
. Đọc thêm cách sử dụng khóa API ở bên dưới để hiểu rõ hơn
Cách sử dụng khóa API
eKMap Platform Maps APIs luôn yêu cầu api_key
trong mọi yêu cầu API. Ví dụ nếu bạn muốn sử dụng dịch vụ chỉ đường bạn có thể gọi dạng REST API, bạn có thể khởi tạo khóa API.
Sau đó thay giá trị khóa API vào chuỗi ký tự {YOUR_API_KEY}
Ví dụ Request:
$ curl "https://api.ekgis.vn/v1/route/direction/osm/driving/105.8096567,21.0127234;105.8324778,21.0037716?overview=full&alternatives=false&steps=false&geometries=geojson&api_key={YOUR_API_KEY}"
eKMap Platform SDKs
eKMap Platform hỗ trợ đa nền tảng để phát triển ứng dụng trên thiết bị di động, bạn có thể tham khảo thêm thông tin:
- eKMap Platform Javascript
- eKMap Platform SDKs for iOS
- eKMap Platform SDKs for Android
- eKMap Platform SDKs for React Native
- eKMap Platform SDKs for Flutter
Giới hạn về số lượng Request
Hãy liên hệ với chúng tôi để được cấp khóa API và sử dụng miễn phí
Một số trạng thái lỗi khi sử dụng
Mã lỗi | HTTP Status Code | Mô tả |
---|---|---|
API_KEY_MISSING | 403 | Khóa API không được cung cấp. Xem cách sử dụng khóa API để biết chi tiết |
API_KEY_INVALID | 403 | Khóa API không hợp lệ |
API_KEY_DISABLED | 403 | Khóa API đã bị quản trị viên vô hiệu hóa |
API_KEY_UNAUTHORIZED | 403 | Khóa API không được phép truy cập vào dịch vụ |
API_KEY_UNVERIFIED | 403 | Khóa API được cung cấp vẫn chưa được xác minh |
HTTPS_REQUIRED | 400 | Yêu cầu đối với API này phải được thực hiện qua HTTPS |
OVER_RATE_LIMIT | 429 | Khóa API đã vượt quá giới hạn tốc độ, xem giới hạn |
NOT_FOUND | 404 | Không thể tìm thấy API tại URL đã cho. Kiểm tra URL của bạn. |
Giá cả
Hãy liên hệ với chúng tôi để được cấp khóa API và sử dụng miễn phí