eVerify API
API xác thực danh tính của VTS (eVerify) cho hệ thống của khách: hiện hỗ trợ xác thực CCCD gắn chip với Bộ Công an (eID C06), sẽ bổ sung vân tay và eKYC. Sản lượng (quota) gọi API được cấp phát qua eDevice; API cho phép tra số dư và lịch sử giao dịch.
Xác thực: header X-API-Key: evf_live_<key_id>_<secret> (không nhận qua Authorization, query hay body). Mỗi ứng dụng tích hợp có một API key, có thể đặt hạn dùng và danh sách IP được phép.
Định dạng response: luôn là { request_id, data, error }. Khi có error, request không được xử lý và không bị tính phí.
Chỉ gọi từ máy chủ: request có header Origin bị từ chối (403 ORIGIN_NOT_ALLOWED), trừ origin của trang tài liệu eVerify ("Try it"). Không đưa API key vào mã chạy trên trình duyệt.
Giới hạn: mặc định 120 request/phút cho mỗi ứng dụng, VTS có thể nâng riêng. Hạn mức đang áp dụng nằm ở header RateLimit-Limit; vượt giới hạn trả 429 kèm Retry-After. Body tối đa 1 MB.
Authentication
- API Key: ApiKeyAuth
API key của ứng dụng tích hợp: evf_live_<key_id>_<secret>.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-API-Key |
Gọi thử
Địa chỉ gốc: https://everify.vtsi.vn/api/v1. Mỗi trang endpoint có request mẫu cho curl, Node.js, Python, Java, C# và PHP. Request mẫu dùng hai biến môi trường:
export EVERIFY_API_KEY="evf_live_..." # thay bằng key của bạn
export EVERIFY_BASE_URL="https://everify.vtsi.vn/api/v1"
Mỗi trang endpoint có khung Gửi thử ở bên phải: dán key vào ô X-API-Key rồi bấm Gửi thử. Key chỉ lưu trong phiên trình duyệt.
Có kết luận là trừ lượt, và cần dữ liệu chip thật. Nên tạo một ứng dụng riêng để thử và thu hồi key sau khi xong. Không dán key vào máy dùng chung.
Bạn cũng có thể dùng Postman hoặc file .http: