Skip to main content

API Keys

Quản lý và sử dụng API keys

Tổng quan

API Keys là phương thức xác thực chính để truy cập AISieure API. Mỗi key có định dạng tiền tố key_ theo sau bởi một chuỗi ký tự ngẫu nhiên.

Lưu ý: API keys được hash bằng thuật toán SHA-256 trước khi lưu vào database. Điều này có nghĩa là key gốc chỉ được hiển thị một lần duy nhất khi tạo — hãy sao chép và lưu trữ cẩn thận.

Ví dụ định dạng API key:

key_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6

Mỗi API key được liên kết với:

  • Tên — tên mô tả để dễ quản lý
  • Gói dịch vụ (Package) — xác định số credits và giới hạn sử dụng
  • Trạng thái — active, suspended, expired hoặc revoked
  • Ngày hết hạn — thời điểm key hết hiệu lực

Xác thực (Authentication)

Sử dụng API key trong header Authorization với định dạng Bearer token cho mọi request đến API:

Authorization: Bearer key_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6

Ví dụ với cURL:

curl https://aisieure.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer key_your_api_key_here" \
  -d '{
    "model": "claude-sonnet-4.6",
    "messages": [
      {"role": "user", "content": "Hello!"}
    ]
  }'

Ví dụ với Python (OpenAI SDK):

from openai import OpenAI

client = OpenAI(
    api_key="key_your_api_key_here",
    base_url="https://aisieure.com/v1"
)

response = client.chat.completions.create(
    model="claude-sonnet-4.6",
    messages=[{"role": "user", "content": "Hello!"}]
)
print(response.choices[0].message.content)
Cảnh báo: Không bao giờ gửi API key qua URL query parameters. Luôn sử dụng header Authorization.

Hệ thống Credits

Mỗi API key được gắn với một gói dịch vụ (package) quy định số credits khả dụng. Credits được trừ sau mỗi lần gọi API dựa trên model và lượng token sử dụng.

Các loại gói dịch vụ

Loại gói Mô tả Reset
monthly Credits được cấp hàng tháng, tự động reset vào đầu mỗi tháng Hàng tháng
daily Credits được cấp hàng ngày, tự động reset vào đầu mỗi ngày Hàng ngày
topup Credits nạp một lần, sử dụng đến khi hết Không reset
unlimited Không giới hạn credits Không áp dụng
Mẹo: Bạn có thể kiểm tra số credits còn lại thông qua Dashboard hoặc liên hệ quản trị viên.

Khi credits hết, API sẽ trả về lỗi 402 Insufficient Credits:

{
  "error": {
    "message": "Insufficient credits. Please upgrade your package or contact admin.",
    "type": "insufficient_credits",
    "code": 402
  }
}

Trạng thái Key

Mỗi API key có một trong các trạng thái sau:

Trạng thái Mô tả Có thể sử dụng?
active Key đang hoạt động bình thường
suspended Key bị tạm ngưng bởi quản trị viên Không
expired Key đã quá hạn sử dụng Không
revoked Key đã bị thu hồi vĩnh viễn Không

Khi sử dụng key không hợp lệ, API trả về mã lỗi tương ứng:

  • 401 Unauthorized — key không tồn tại hoặc sai định dạng
  • 403 Forbidden — key bị suspended hoặc revoked
  • 403 Forbidden — key đã expired

Bảo mật API Key

Tuân thủ các nguyên tắc sau để bảo vệ API key của bạn:

Không commit key vào source code

Thêm file chứa key vào .gitignore:

# .gitignore
.env
.env.local
.env.production

Sử dụng biến môi trường

Lưu API key trong biến môi trường thay vì hardcode:

# .env
AISIEURE_API_KEY=key_your_api_key_here
# Python
import os
api_key = os.environ.get("AISIEURE_API_KEY")

# Node.js
const apiKey = process.env.AISIEURE_API_KEY;

Xoay vòng key định kỳ

Tạo key mới và vô hiệu hóa key cũ theo định kỳ (khuyến nghị mỗi 90 ngày) để giảm thiểu rủi ro.

Phân quyền theo mục đích

Tạo các key riêng biệt cho từng ứng dụng hoặc môi trường (development, staging, production) để dễ dàng quản lý và thu hồi khi cần.

Cảnh báo: Nếu bạn nghi ngờ API key bị lộ, hãy thu hồi (revoke) ngay lập tức và tạo key mới thông qua Dashboard.