Xác thực

Mọi yêu cầu đều phải kèm khóa API của bạn. Hãy gửi khóa trong header Authorization dưới dạng bearer token, hoặc trong header X-Api-Key nếu client của bạn không thể đặt Authorization.

Header#

Authorization: Bearer xca_live_…
# or
X-Api-Key: xca_live_…

curl -s "https://app.xca.fun/api/v1/new-pairs?limit=5" \
  -H "X-Api-Key: $XCA_API_KEY"

Định dạng khóa#

Khóa bắt đầu bằng xca_live_, theo sau là một chuỗi base58 ngẫu nhiên. XCA chỉ lưu hash của khóa, nên khóa bị mất không thể khôi phục: hãy tạo khóa mới.

Giữ bí mật khóa#

• Gọi API từ server hoặc bot của bạn, không bao giờ gọi từ trang web công khai hay từ bản build của ứng dụng di động.
• Không commit khóa vào repository; hãy nạp khóa từ biến môi trường hoặc trình quản lý secret.
• Dùng một khóa riêng cho mỗi dự án để có thể thu hồi một khóa mà không ảnh hưởng đến các khóa khác.
• Khóa đã bị thu hồi sẽ ngừng hoạt động ngay lập tức.

Xoay vòng khóa#

Tạo khóa mới, triển khai khóa đó, kiểm tra để chắc chắn các yêu cầu đều thành công, rồi thu hồi khóa cũ trên trang API.

Lỗi xác thực#

Khóa bị thiếu, sai định dạng hoặc đã bị thu hồi sẽ trả về 401 unauthorized. Khóa hợp lệ nhưng thuộc gói không có quyền truy cập API sẽ trả về 402 planRequired.

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key"
  }
}