Khóa API

Để sử dụng bất kỳ API nào của eKAPI, bạn sẽ cần khóa API. Bạn có thể đăng ký sử dụng API Key

Cách sử dụng khóa API

eKAPI cung cấp hai loại khóa API

  • Khóa API để sử dụng xem các bạng đồ dạng Tile
  • Khóa REST API sử dụng cho tất cả các REST APIs

Ví dụ: Nếu bạn muốn hiển thị bản đồ Việt Nam sử dụng Maplibre GL JS, 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}:

var map = new maplibregl.Map({
    container: 'map', // container id
    style: {
        'version': 8,
        'sources': {
            'raster-tiles': {
                'type': 'raster',
                'tiles': [
                    'https://api.ekgis.vn/v1/maps/vietnam/{z}/{x}/{y}.png?api_key={YOUR_API_KEY}'
                ],
                'tileSize': 256,
                'attribution':
                    'Map by <a target="_top" rel="noopener" href="https://ekgis.com.vn">eKMap</a>'
            }
        },
        'layers': [
            {
                'id': 'simple-tiles',
                'type': 'raster',
                'source': 'raster-tiles',
                'minzoom': 0,
                'maxzoom': 22
            }
        ]
    },
    center: [107.19, 16.22], // starting position
    zoom: 4 // starting zoom
});

Hoặc 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}"

Giới hạn về số lượng Request

Theo mặc định, một tài khoản được miễn phí

  • 1000 yêu cầu mỗi ngày, 5 yêu cầu mỗi giây trên mỗi địa chỉ IP,
  • 30000 yêu cầu mỗi tháng, 500 yêu cầu mỗi giây trên mỗi địa chỉ IP.

Nếu bạn cần giới hạn cao hơn hãy liên hệ với chúng tôi

Một số trạng thái lỗi khi sử dụng

Mã lỗiHTTP Status CodeMô tả
API_KEY_MISSING403Khóa API không được cung cấp. Xem cách sử dụng khóa API để biết chi tiết
API_KEY_INVALID403Khóa API không hợp lệ
API_KEY_DISABLED403Khóa API đã bị quản trị viên vô hiệu hóa
API_KEY_UNAUTHORIZED403Khóa API không được phép truy cập vào dịch vụ
API_KEY_UNVERIFIED403Khóa API được cung cấp vẫn chưa được xác minh
HTTPS_REQUIRED400Yêu cầu đối với API này phải được thực hiện qua HTTPS
OVER_RATE_LIMIT429Khóa API đã vượt quá giới hạn tốc độ, xem giới hạn
NOT_FOUND404Không thể tìm thấy API tại URL đã cho. Kiểm tra URL của bạn.