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ức | Header | Dùng cho | Quả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 Key | x-api-key: <key> | Tích hợp server-to-server | Khô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
| Endpoint | Method | Mô tả | Xác thực |
|---|---|---|---|
/v1/auth/login | POST | Đăng nhập bằng email + password, trả về access_token và refresh_token | Không |
/v1/auth/refresh | POST | Làm mới access token bằng refresh token (header authorization) | Có |
/v1/auth/change-password | POST | Đổi mật khẩu cho user đang đăng nhập | Có |
/v1/me/plan-status | GET | Xem trạng thái gói: hạn dùng, quota còn lại, số dư credits | Có |
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
| Header | Giá trị |
|---|---|
Content-Type | application/json |
Accept | application/json |
Authorization hoặc x-api-key | Bearer <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-statushoặc trên Dashboard.
Mã lỗi thường gặp
| Mã lỗi | Ý nghĩa | Cách xử lý |
|---|---|---|
| 401 Unauthorized | Token hoặc API Key thiếu, sai hoặc hết hạn | Kiểm tra lại header Authorization hoặc x-api-key |
| 403 Forbidden | Tài khoản bị khóa hoặc không đủ quyền | Kiểm tra trạng thái tài khoản trên Dashboard |
| 429 Too Many Requests | Vượt quá rate limit | Giảm tần suất gọi hoặc nâng cấp gói |
| 400 Bad Request | Hết quota và không còn Credits | Nâng cấp gói hoặc mua thêm Credits |
Liên kết liên quan
- Làm theo: Xác thực API requests — hướng dẫn từng bước kèm ví dụ mã nguồn
- Cấu hình: Tham chiếu cấu hình — base URL, rate limit
- API Reference đầy đủ: openapi.elim.asia/api