プラグイン、デスクトップアプリ、ウェブサイトなどの独自アプリケーションから、ユーザーのためにチケットを作成し、アプリケーションやサーバーのバージョンなどの技術情報を一緒に送信できます。アプリケーションごとに専用のキーが発行されます。キーを無効化すると、そのアプリケーションは直ちに利用できなくなります。
場所: セットアップ → サポート → アプリケーションキー(管理者のみ)。
アプリケーションキーを作成する
- セットアップ → サポート → アプリケーションキー を開きます。
- アプリケーション の名前(例:
WordPress plugin)を入力します。スタッフには、この名前がそのアプリケーションが作成したチケットのチャネルとして表示されます。 - リクエストで製品が指定されない場合の製品 を選択するか、リクエストで製品の指定を必須にする を選択します。
- キーを作成 をクリックします。
- 今すぐキーをコピーし、アプリケーションの設定に保存してください。キーが表示されるのはこの一度だけです。Ticketix はキーのハッシュのみを保存します。
一覧には、各アプリケーションのキーの先頭部分、製品、チケット数、最終使用日時、作成日時が表示されます。取り消す を使うとキーは即座に無効になります。そのアプリケーションが作成したチケットには、アプリケーション名がそのまま残ります。
チケットを作成する
インストール先のアドレス配下にある /api/ticket-create.php に、JSON 本文を付けて POST リクエストを送信します(例: https://support.example.com/api/ticket-create.php)。キーは Authorization: Bearer ヘッダーで送信します。サーバーが Authorization ヘッダーを削除する環境では X-Ticketix-Key を使用してください。
POST /api/ticket-create.php
Authorization: Bearer tkx_…
Content-Type: application/json
{
"email": "customer@example.com",
"name": "Customer Name",
"product": "helpdesk",
"subject": "Licence shows Inactive after moving the site",
"message": "We moved the site to a new domain …",
"priority": "normal",
"technical_details": {
"WordPress": "6.8",
"PHP": "8.3",
"Plugin version": "2.0.2"
}
}
| フィールド | 必須 | 意味 |
|---|---|---|
| はい | お客様のメールアドレス。未登録のアドレスの場合は新しいお客様が作成されます | |
| name | いいえ | お客様の名前(最大 120 文字) |
| product | いいえ | 製品キー。省略した場合はキーに紐づく製品が使用されます |
| subject | はい | 最大 200 文字 |
| message | はい | プレーンテキスト(最大 20,000 文字) |
| priority | いいえ | low、normal(既定)または high |
| technical_details | いいえ | 最大 30 個の名前と値。名前は最大 60 文字、値は最大 500 文字。値はテキスト、数値、true または false |
リクエスト本文は最大 64 KB です。
チケットの処理
- チケットはすぐにオープンになります。キーがリクエストを保証するため、メール認証はありません。
- お客様にはチケットのリンクを含む通常の チケット作成 メールが届き、スタッフには通常の通知が届きます。
- ルーティングルール、ワークフロー、SLA ポリシー、AI トリアージは、他の新規チケットと同様に実行されます。
- チケット画面では、チャネルとしてアプリケーション名と「技術情報あり」が表示され、最初のメッセージの下に技術情報(「送信元」とアプリケーション名)が表示されます。お客様も自分のチケットで同じ情報を確認できます。
レスポンス
| ステータス | 意味 |
|---|---|
| 201 | チケットが作成されました。レスポンスには ticket_no と status が含まれます |
| 401 | キーがない、誤っている、または取り消されています |
| 405 | リクエストが POST ではありません |
| 413 | 本文が 64 KB を超えています |
| 415 | 本文が JSON(Content-Type: application/json)ではありません |
| 422 | 項目に誤りがあります。fields に各項目と理由が示されます |
| 429 | チケットが多すぎます。上限はアプリケーションごとに 1 時間 60 件、お客様ごとに 1 時間 10 件です |
Nginx では、api フォルダーで PHP を実行できるようにする必要があります。Ticketix のサーバー要件をご覧ください。
関連記事
まだ解決しませんか?
コミュニティに質問する