說明文件

更快上手 TicketsX

設定指南、完整指令說明、Premium 功能和 REST API 都在這裡。

13.1

驗證

API 權杖在 TicketsX 控制台的伺服器側邊欄中建立與管理。每個權杖只綁定一個伺服器,建立與使用都需要該伺服器擁有有效的 Premium 訂閱。

建立權杖

  • Premium 頁面為伺服器啟用 Premium(API 存取頁面有直達連結)。
  • 開啟伺服器側邊欄,前往 API 存取
  • 為權杖取個名稱(例如「客服機器人」或「CRM 同步」)。
  • 點選建立權杖,複製顯示出來的值。
  • 把它保存到密鑰管理工具中;關閉提示條之後就再也看不到了。

如果 Premium 到期

你的權杖不會被刪除。在訂閱重新生效之前,所有 API 請求都會回傳 402premium_required: true,而且無法建立或輪替權杖。列出、停用與撤銷仍然可用,方便你在這段期間整理。在你的整合中,請比照處理 401 的方式處理 402:停止重試並通知人員。

伺服器沒有 Premium 時的回應
{
  "error": "The TicketsX REST API is a Premium feature. Activate Premium for this server to use API tokens.",
  "premium_required": true
}

撤銷權杖會立即讓它在所有端點上失效。如果不希望中斷,請先建立替代權杖。

使用權杖

每個請求都要在 Bearer 標頭中帶上權杖。所有請求都只作用於建立該權杖的那個伺服器。

帶驗證的請求範例
curl -X GET \
  -H "Authorization: Bearer <API_TOKEN>" \
  https://api.ticketsx.xyz/<guild_id>/api/tickets