【APIトークン廃止対応】利用中のAPIトークンの用途を特定する方法

APIトークンがどのシステムで何に使われているかを知りたい場合は、APIトークン一覧の説明と利用ログを起点に、アプリやWebhook、トリガの設定と照合します。

ログから操作の種類を読み取り、送信元の候補を絞ることができます。ただし、システム名を確定するには、連携設定や実行履歴の確認が必要な場合があります。

確認する順序

1. トークン一覧 → 2. APIトークンログ → 3. 処理の種類の読み解き → 4. アプリ → 5. Webhook → 6. トリガ → 7. 「6」までで特定できない場合

左から順に確認し、利用先の候補を絞り込んでいきます。

1. トークン一覧で用途の手掛かりを探す

管理センターへアクセスし、[アプリおよびインテグレーション]  >  [API]  >  [APIトークン] を開きます。

図1 APIトークン一覧の画面例

まず「説明」欄から、アプリ名、チケット取得、データ連携などの用途の手掛かりを探します。

次に、対象トークンの「ID」と「最終使用日時」を控えます。IDだけでは処理内容が分からないため、手順2のログで確認します。なお「アクティブ」は使用可能な状態を表すだけで、実際に使われ続けているかどうかはログで判断します。

参考：Zendesk公式ヘルプ「APIトークンの管理」

2. APIトークンログで実際のリクエストを確認する

ログに記録されるのは直近7日分または最大500MBの範囲です。月次・四半期の処理は含まれないことがあるため、定期的にログを保存して観測期間を広げ、定期処理の実行予定とも照合することをおすすめします。

▪️ ログを取得する

APIトークン一覧の右上にある「APIトークンログを生成」を選択します。ファイルはメールで送信されます。ファイルを保存し、圧縮ファイルの場合は展開してCSVを開きます。

▪️ 対象トークンの行を絞り込む

一覧に表示されている英数字のIDと、CSVの token_identifier（図2のQ列）を照合して、対象の行を絞り込みます。

図2 APIトークンログの確認箇所

参考：Zendesk公式ヘルプ「利用レポートの期間と列の説明」

3. エンドポイントから処理の種類を読み解く

method と url を組み合わせると、何に対してどの操作を行ったかを読み取れます。下表の「利用先の候補」は、調査の当たりを付けるための例です。同じAPIを複数のアプリやスクリプトが使うため、APIだけで製品名を確定することはできません。

※URLのドメインは省略しています。{id}・{locale} は実際の値に置き換わる箇所です。.json の有無などの表記差があります。
※Tickets APIは主にエージェント向け、Requests APIは利用者が参照できる範囲の問い合わせ操作向けです。

▪️ user_agentから呼び出し元を読み解く

ログの user_agent には、APIを呼び出したプログラムやサービスの情報が記録されます。method・url とあわせて確認すると、利用先の種類を絞り込む手掛かりになります。

※user_agentは呼び出し側のプログラムで変更できるため、送信元を確定する情報ではありません。IPアドレスや実行時刻とあわせて判断してください。

4. インストール済みアプリを確認する

説明やログからアプリの候補が見えたら、管理センターの［アプリおよびインテグレーション］＞［アプリ］＞［Zendesk Supportアプリ］を開き、「現在インストール済み」と「プライベートアプリ」を確認します。

Zendeskの画面上（サイドバーやナビバーなど）で動くアプリは、通常、ログイン中のユーザーのセッションで認証してAPIを使うため、APIトークンは使用しません。

APIトークンと関係する可能性があるのは、トリガやWebhookを作成するアプリ、チャネルインテグレーションのアプリなど、Zendeskに設定を追加するタイプのアプリや、提供元のサーバーからZendesk APIを呼び出すアプリです。

図3 アプリ一覧の画面例

1. 該当しそうなアプリについて、設定や提供元の資料から、Zendeskにどのような設定（トリガ・Webhookなど）を追加するか、提供元のサーバーでどのような処理を行うかを確認します。
2. 確認した処理内容と、APIトークンログの method・url が示す操作を照合します。
   例えば、ユーザー情報を更新するアプリであれば、ログにユーザー更新のリクエストがあるかを確認し、利用先の候補を絞ります。
   処理内容が一致していても、そのアプリが対象のAPIトークンを使用しているとは限りません。
3. 対応関係が分からない場合は、処理内容や実行時刻を手掛かりに、開発元・提供元へ確認してください。

なお、Zendesk外のフォームや連携システムなど、インストール済みアプリの一覧に表示されない利用先もあります。

参考：Zendesk公式ヘルプ「インストール済みアプリの管理」

5. Webhookの送信先と認証方式を確認する

管理センターへアクセスし、[アプリおよびインテグレーション]  >  [Webhook]  >  [Webhook] を開きます。説明やログと関係しそうなWebhookを探し、名前、説明、状態、エンドポイントURL、リクエスト方法、認証方式を確認します。

図4 Webhook設定の画面例

エンドポイントがZendesk APIであれば、URLとGET・POST・PUTなどの方法から対象の操作を確認します。この場合、認証方式の設定に、対象のAPIトークンが使われていることがあります。

外部サーバーのURLであれば、認証方式の設定は送信先の外部サービスへ接続するためのもので、ZendeskのAPIトークンとは別のものです。送信先サービスの仕様や処理履歴を調べ、その後にZendesk APIを呼んでいるかを確認します。

参考：Zendesk公式ヘルプ「Webhookの管理」／「接続方式の違い」

6. トリガの条件と送信内容を確認する

管理センターへアクセスし、[オブジェクトとルール]  >  [ビジネスルール]  >  [トリガ] を開きます。

図5のフィルターで、タイプを「アクション」、カテゴリを「通知方法 ＞ アクティブなWebhook」にして絞り込みます。各トリガの「アクション」で、対象のWebhookへの通知があるかを確認します。

図5 Webhookを使用するトリガの絞り込み例

▪️ 「条件」で、いつ動くかを確認する

作成時か更新時か、対象のフォーム・ブランド・タグ・項目値は何か、「すべて」と「いずれか」のどちらに設定されているかを確認します。

▪️ 「アクション」で、何を送っているかを確認する

通知先のWebhookと、JSON本文・URLパラメーターを確認します。

図6 トリガのアクションの画面例

図6の例では、WebhookのPUTと users のURLから、ユーザー更新が候補になります。本文の user.name と ticket_field_123456789 から、チケットのカスタム項目をユーザー名へ転記する意図が読み取れます。項目IDが何を表すかは、チケットフィールドの設定と照合します。

設定から分かるのは処理の意図です。実際に実行・成功しているかは、Webhookのアクティビティ、APIログ、対象レコードで照合します。

参考：Zendesk公式ヘルプ「トリガの条件とアクション」／「Webhook通知アクション」

7. ここまでで特定できない場合の確認方法

ここまでで特定できない場合は、ログのURL・実行時刻・IP・user_agentをまとめ、サーバー管理者や連携担当者に、該当する処理があるかをご確認ください。フォームやバッチの設定資料、連携サービスの接続設定、実行履歴を優先して照合します。

▪️ よくある判断の迷い

Zendeskサポートへのお問い合わせ

ここまでの手順で利用先を特定できない場合は、Zendeskサポートでも調査が可能です。お問い合わせの際は、下記の情報を添えていただくと、調査がスムーズに進みます。

Zendeskサポートへのお問い合わせ方法はこちら

• 対象のトークンの説明と識別子、ログの対象期間、分からない点
• 該当行のmethod・URL・実行時刻・status_code（必要に応じてIP・user_agent・アプリ名）
• 候補がある場合は、Webhookやトリガの設定画面