13
API リファレンス
TicketsX の REST API を使うと、外部のツールをサーバーのチケットシステムに連携できます。Discord の画面を使わずにチケットの作成・クローズ・管理を行い、履歴のアーカイブ全体を検索し、クローズ済みチケットの本文や HTML を取得できます。
REST API は Premium の機能です。 API トークンの作成と利用は、サーバーに有効な Premium 契約がある間だけ可能です(詳しくは料金ページ)。Premium のないサーバーからのリクエストは 402 と premium_required: true で拒否されます。Premium が失効した場合、既存のトークンは残りますが、再び有効にするまで動作しません。その間もダッシュボードから一覧表示、無効化、取り消しはいつでもできます。
https://api.ticketsx.xyzすべてのリクエストには、Authorization ヘッダーに Bearer トークンとして渡す API トークンが必要です。トークンは 1 つのサーバー専用で、操作ごとに権限を絞れます。
Authorization: Bearer <API_TOKEN>以下のエンドポイントのパスでは、<guild_id> を自分の Discord サーバー ID に、<ticket_id> を対象チケットの ID に置き換えてください。
POST のリクエストボディにはすべて Content-Type: application/json が必要です。4xx の応答には JSON の error フィールドが含まれます。401 はトークンが無効、期限切れ、または取り消し済みであることを示します。402 はサーバーに Premium がないことを示します(応答には premium_required: true も含まれます)。403 はトークンが無効化されているか、必要な権限がないことを示します。429 はレート制限に達したことを示し(「レート制限と安全対策」を参照)、retry_after の値が秒単位で含まれます。