認証

API トークンは、TicketsX ダッシュボードのサーバーサイドバーから作成・管理します。各トークンは 1 つのサーバーに紐づき、作成にも利用にもサーバーの有効な Premium 契約が必要です。

トークンの作成

• Premium のページからサーバーの Premium を有効にします(API アクセスのページから直接リンクがあります)。
• サーバーのサイドバーを開き、API アクセス に移動します。
• トークンに名前を付けます(例:「サポートボット」「CRM 連携」)。
• トークンを作成 をクリックし、表示された値をコピーします。
• シークレット管理の仕組みに保存してください。バナーを閉じると再表示はできません。

Premium が失効した場合

トークンは削除されません。契約が再び有効になるまで、すべての API リクエストが 402 と premium_required: true を返し、トークンの作成と差し替えはできなくなります。一覧表示、無効化、取り消しは引き続き使えるので、整理は可能です。連携側では 402 を 401 と同じように扱い、再試行をやめて担当者に知らせてください。

{
  "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