Chuyển đến nội dung chính
Elimapi

Tham chiếu xác thực API

Tóm tắt

Elimapi hỗ trợ hai phương thức xác thực. Mọi request API đều cần kèm thông tin xác thực trong header.

Phương thứcHeaderDùng choQuản lý phiên
Access Token (JWT)Authorization: Bearer <token>Ứng dụng có giao diện người dùngĐăng nhập định kỳ, token có thời hạn
API Keyx-api-key: <key>Tích hợp server-to-serverKhông cần, key gắn với tài khoản

Hướng dẫn từng bước: Xác thực API requests

Endpoint xác thực

EndpointMethodMô tảXác thực
/v1/auth/loginPOSTĐăng nhập bằng email + password, trả về access_tokenrefresh_tokenKhông
/v1/auth/refreshPOSTLàm mới access token bằng refresh token (header authorization)
/v1/auth/change-passwordPOSTĐổi mật khẩu cho user đang đăng nhập
/v1/me/plan-statusGETXem trạng thái gói: hạn dùng, quota còn lại, số dư credits

Login request body:

{
  "email": "[email protected]",
  "password": "password"
}

Login response: { user, access_token, expires_in, refresh_token }expires_in là timestamp (ms) hết hạn của token.

Header bắt buộc

HeaderGiá trị
Content-Typeapplication/json
Acceptapplication/json
Authorization hoặc x-api-keyBearer <token> hoặc <api_key>

Định mức và giới hạn (Quotas & Limits)

  • Gói đăng ký (Subscription): Nếu gói (Free, Individual, Team, Enterprise) hết hạn, các request API bị từ chối.
  • Lượt yêu cầu (Usage Quota): Mỗi request thành công trừ vào tổng lượt trong tháng của gói.
  • Tín dụng (Credits): Hết quota của gói, hệ thống tự động trừ vào số dư Credits (nếu có).
  • Rate Limit: Giới hạn tốc độ gọi API để đảm bảo ổn định hệ thống.

Kiểm tra hạn mức hiện tại qua GET /v1/me/plan-status hoặc trên Dashboard.

Mã lỗi thường gặp

Mã lỗiÝ nghĩaCách xử lý
401 UnauthorizedToken hoặc API Key thiếu, sai hoặc hết hạnKiểm tra lại header Authorization hoặc x-api-key
403 ForbiddenTài khoản bị khóa hoặc không đủ quyềnKiểm tra trạng thái tài khoản trên Dashboard
429 Too Many RequestsVượt quá rate limitGiảm tần suất gọi hoặc nâng cấp gói
400 Bad RequestHết quota và không còn CreditsNâng cấp gói hoặc mua thêm Credits

Liên kết liên quan