この記事では、Chat APIクライアントとOAuthトークンの管理方法について概要を説明します。既存のクライアントを作成および削除する方法と、OAuthアクセストークンの作成および取り消す方法について説明します。

APIクライアントは、APIリクエストを認証するためのOAuthアクセストークンを作成するために使用されます。旧バージョンのChat専用アカウントの場合、APIリクエストの認証方法は2とおりあります。

  • ユーザー名とパスワードによる基本認証
  • OAuthアクセストークン

Chat + SupportまたはChatフェーズ4アカウントを使用している場合、APIリクエストを認証する方法は1つだけです。

  • OAuthアクセストークン

Chatアカウントのタイプについて詳しくは、「Chatアカウントのタイプについて」を参照してください。API認証の詳細については、Chat APIドキュメントの「Security and Authentication」を参照してください。

この記事では、次のトピックについて説明します。

  • APIクライアントを管理する
  • APIクライアントを作成する
  • APIクライアントを削除する
  • トークンを作成する
  • トークンを取り消す
  • その他の参考資料

APIクライアントを管理する

管理者はChatインターフェイスから、アクティブなAPIクライアントを簡単に表示および削除することができます。ユーザーは、自分が作成したクライアントのみを見ることができます。

アクティブなクライアントを表示するには、Chatダッシュボードに移動して「設定」>「アカウント」>「APIおよびSDK」を選択します。

この画面で、表示または更新するクライアントを選択することができます。また、クライアントシークレットの再生成やクライアントの削除も行うことができます。

APIクライアントを作成する

社内用にOAuthトークンを作成する場合は、次の手順に従います。サードパーティのインテグレーション用のクライアントの場合、インテグレーションの開発元が提供するインストール手順に従います。

クライアントを作成するには、Chatダッシュボードに移動して「設定」>「アカウント」>「APIおよびSDK」を選択し、「APIクライアントを追加」ボタンをクリックします。

クライアントフィールドの入力方法について詳しくは、Chat APIドキュメントの「Adding an API client」を参照してください。

APIクライアントを削除する

クライアントを削除する前に、サードパーティのサービスに与える可能性のある影響について確認してください。クライアントの「リダイレクトURL」フィールドが「localhost」以外に設定されている場合、クライアントは外部インテグレーションとやりとりしている可能性があります。そのようなクライアントを削除する場合は、別のクライアントを作成する必要があります。トークン作成プロセス中に、外部インテグレーションのユーザーは、自分のChatアカウントへのアクセスをインテグレーションに再度付与する必要があります。リダイレクトURLがlocalhostである場合、そのクライアントはおそらく社内API用に作成されたものです。

クライアントを削除するには

  1. Chatダッシュボードから、「設定」>「アカウント」>「APIおよびSDK」を選択し、リストからクライアントを選択します。
  2. 「選択項目を削除」ボタンをクリックします。

また、APIを使用してAPIクライアントを管理することもできます。APIドキュメントの「OAuth Clients」を参照してください。

トークンを作成する

APIクライアントを作成したら、APIリクエストを認証するためのOAuthアクセストークンを作成できます。

アクセストークンを作成するには、本番環境向けの長くて正式な方法と、テスト環境向けの短くて便利な方法の2とおりがあります。

それぞれの方法の手順については、「OAuthトークンの生成（Chatの統合アカウント）」を参照してください。

トークンを取り消す

トークンを取り消せるのは、トークンを作成したユーザーのみです。管理者であっても、他のユーザーが作成したトークンを取り消す権限はありません。

トークンを取り消すには、OAuthトークンAPIを使用します。手順は以下のとおりです。

  1. トークンをリストアップして、削除したいトークンのIDを取得します。

    APIドキュメントの「List Tokens」を参照してください。

    トークンの数が多い場合は、トークンを作成したおおよその日時を把握しておくと、リスト内で識別しやすくなります。

  2. IDを指定してトークンを取り消します。

    APIドキュメントの「Revoke Token」を参照してください。

その他の参考資料

この記事では、APIクライアントとOAuthアクセストークンの概要について説明しました。詳細については、以下の記事を参照してください。

  • Chat APIドキュメントの「OAuth Authentication」
  • OAuthトークンの生成（Chatの統合アカウント）
Powered by Zendesk