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

​
Tổng quan

Khóa API xác thực các ứng dụng phía server của bạn với API AgentWallex. Mỗi khóa bắt đầu bằng tiền tố awx_ và được liên kết với tài khoản của bạn.

​
Tạo Khóa API

Tạo khóa API thông qua dashboard hoặc REST API (yêu cầu xác thực JWT):

​
Qua Dashboard

  1. Đăng nhập vào AgentWallex Dashboard.
  2. Điều hướng đến Settings > API Keys.
  3. Nhấp Create API Key.
  4. Đặt tên mô tả cho khóa (ví dụ: production-backend, staging-ci).
  5. Sao chép và lưu trữ khóa an toàn — nó chỉ được hiển thị một lần.

​
Qua API

curl -X POST https://api.agentwallex.com/api/v1/api-keys \
  -H "Authorization: Bearer eyJhbGciOi..." \
  -H "Content-Type: application/json" \
  -d '{"name": "production-backend"}'
Khóa API đầy đủ chỉ được trả về một lần tại thời điểm tạo. Lưu trữ nó ngay lập tức trong trình quản lý bí mật an toàn.

​
Liệt kê Khóa API

curl -X GET https://api.agentwallex.com/api/v1/api-keys \
  -H "Authorization: Bearer eyJhbGciOi..."
Phản hồi bao gồm metadata của khóa nhưng không bao giờ chứa giá trị khóa đầy đủ: 
{
  "data": [
    {
      "id": "key_abc123",
      "name": "production-backend",
      "prefix": "awx_...x4f2",
      "created_at": "2025-06-01T10:00:00Z",
      "last_used_at": "2025-06-15T14:30:00Z"
    }
  ]
}

​
Xoay Khóa API

1

Tạo khóa mới

Tạo khóa API mới qua dashboard hoặc API.
2

Cập nhật ứng dụng

Triển khai khóa mới vào biến môi trường của ứng dụng.
3

Xác minh khóa mới hoạt động

Xác nhận rằng các cuộc gọi API thành công với khóa mới.
4

Xóa khóa cũ

Xóa khóa cũ để ngăn truy cập trái phép:
curl -X DELETE https://api.agentwallex.com/api/v1/api-keys/key_abc123 \
  -H "Authorization: Bearer eyJhbGciOi..."
Xoay khóa API ít nhất mỗi 90 ngày. Đặt lời nhắc lịch hoặc tự động hóa việc xoay khóa với pipeline CI/CD của bạn.

​
Giới hạn Tốc độ

Giới hạn tốc độ API phụ thuộc vào cấp gói của bạn:
GóiYêu cầu/phútYêu cầu/ngàyKết nối đồng thời
Starter6010,0005
Growth300100,00025
EnterpriseTùy chỉnhTùy chỉnhTùy chỉnh
Khi bạn vượt quá giới hạn tốc độ, API trả về phản hồi 429 Too Many Requests với header Retry-After: 
{
  "code": "rate_limit_exceeded",
  "type": "rate_limit_error",
  "message": "Rate limit exceeded. Retry after 30 seconds."
}
Giới hạn tốc độ được áp dụng theo từng khóa API. Nếu bạn cần giới hạn cao hơn, liên hệ đội ngũ AgentWallex hoặc nâng cấp gói của bạn.

​
Các phương pháp tốt nhất

  • Một khóa cho mỗi môi trường — Sử dụng khóa riêng biệt cho development, staging và production.
  • Đặt tên khóa mô tả — Bao gồm tên môi trường và dịch vụ (ví dụ: prod-payment-service).
  • Giám sát việc sử dụng — Kiểm tra last_used_at để xác định các khóa không sử dụng cần được xóa.
  • Không bao giờ chia sẻ khóa — Mỗi thành viên nhóm hoặc dịch vụ nên có khóa riêng.
  • Sử dụng trình quản lý bí mật — Lưu trữ khóa trong AWS Secrets Manager, HashiCorp Vault hoặc các công cụ tương tự thay vì trong tệp .env trên đĩa.