Xác thực

Khóa API được tạo và quản lý ở thanh bên máy chủ trong bảng điều khiển TicketsX. Mỗi khóa gắn với một máy chủ, và muốn tạo hay dùng khóa thì máy chủ phải còn gói Premium hiệu lực.

Tạo khóa

Bật Premium cho máy chủ từ trang Premium (trang Truy cập API dẫn thẳng tới đó).
Mở thanh bên của máy chủ rồi vào Truy cập API.
Đặt tên cho khóa (ví dụ "Bot hỗ trợ" hoặc "Đồng bộ CRM").
Bấm Tạo khóa rồi sao chép giá trị hiện ra.
Cất nó vào kho lưu thông tin mật; đóng thông báo rồi thì bạn không xem lại được nữa.

Nếu Premium hết hạn

Khóa của bạn không bị xóa. Mọi yêu cầu API bắt đầu trả về 402 kèm premium_required: true, còn việc tạo hay thay khóa bị chặn cho tới khi gói thuê bao hoạt động trở lại. Việc liệt kê, tắt và thu hồi khóa vẫn chạy, nên dọn dẹp lúc nào cũng được. Trong phần tích hợp của bạn, hãy xử lý 402 y như 401: ngừng thử lại và báo cho một người biết.

Phản hồi khi máy chủ không có Premium

{
  "error": "The TicketsX REST API is a Premium feature. Activate Premium for this server to use API tokens.",
  "premium_required": true
}

Thu hồi một khóa là nó mất hiệu lực ngay ở mọi điểm cuối. Nếu không muốn gián đoạn, hãy tạo khóa thay thế trước.

Dùng khóa

Gửi khóa dưới dạng tiêu đề Bearer ở mọi yêu cầu. Mọi yêu cầu chỉ có giá trị với chính máy chủ đã tạo ra khóa.

Ví dụ về yêu cầu đã xác thực

curl -X GET \
  -H "Authorization: Bearer <API_TOKEN>" \
  https://api.ticketsx.xyz/<guild_id>/api/tickets