Conversations APIキーの使用

現在のプランを確認

Suite

Professional、Enterprise、またはEnterprise Plus

Sunshine Conversations APIを使用してリクエストを行う場合、発信者の身元を確認するために認証が必要です。発信者の身元を確認するには、基本認証またはJSON Webトークン（JWT）のいずれかを使用できます。どちらの方法にもAPIキーが必要です。APIキーは、「Conversations API」ページを使用して作成します。

メモ：ここで説明するAPIキーは、「管理センターでの会話のインテグレーション」で取り上げたAPIキーとは異なります。ここで説明するConversations APIキーは、アプリレベルの認証を想定しています。会話のインテグレーションに使用するAPIキーは、会話のインテグレーションに特化したものです。

「Conversations API」ページへのアクセスは、Zendesk Suite Professionalプラン以上に含まれています。この機能を利用するには、Zendeskエージェントワークスペースがアクティブにされている必要があります。さらに多くの月間アクティブユーザー数（MAU）や通知が必要な場合は、追加のアドオンパックを利用できます。詳細については、「Zendesk Suiteのアドオンについて」を参照してください。

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

• APIキーについて
• IDおよびAPIキーの作成と共有

APIキーについて

アプリケーションまたはユーザーを識別して認証するAPIキーは、次の3つの部分から構成されます。

• アプリID：Zendeskアカウントを識別します。
• キーID：シークレットキーと一緒に使用することで、JWTやAPIコールの認証に使用される資格情報です。
• シークレットキー：認証パスワードです。

基本認証では、APIキーを直接使用してリクエストを作成します。キーIDはユーザー名で、シークレットはパスワードです。

JWTでは、APIキーでトークンを署名し、そのトークンをAPIでの認証に使用します。キーIDはkidプロパティとしてJWTヘッダーに含まれ、シークレットはJWTに署名します。

APIキーは、認証トークンほど安全ではありません。本番環境でAPIキーを使用する場合は、資格情報を安全に取り扱うためのベストプラクティスに従ってください。

Sunshine Conversationsの認証の詳細については、「API Authentication」を参照してください。

Sunshine ConversationsのAPIキーは、メッセージングの認証キーとは異なります。メッセージング認証キーは、Zendesk SDKを使用するエンドユーザーを認証するための資格情報に署名するために使用されます。ここでのAPIキーは、サーバー間コール用で、appスコープをサポートするSunshine ConversationsのパブリックAPIへのアクセスを提供します。

IDおよびAPIキーの作成と共有

Zendeskの管理者はAPIキーを作成し、開発者と共有する必要があります。キーは最大10個まで保存できます。

APIキーを作成して共有するには

1. 管理センターで、サイドバーの「 アプリおよびインテグレーション」をクリックし、「API」>「Conversations API」を選択します。
   メモ：このウィンドウを表示するには、Zendesk Suite Professionalプラン以上が必要です。
2. 「APIキーを作成」をクリックします。

   このボタンは、初めてキーを作成する場合はページの下部に表示され、以前にキーを作成したことがある場合は右上に表示されます。

3. 「新規キーを作成」ダイアログで、わかりやすいキー名を入力し、「次へ」をクリックします。
4. 「共有シークレットのコピー」ダイアログで各IDと共有キーについて「コピー」をクリックしてクリップボードに保存し、「次へ」をクリックします。

   APIウィンドウに戻ると、新しいキーがリストに表示されます。

新しいキーを生成して最大10個の上限を超えた場合、未使用のキーを削除するよう求める通知が表示されます。

未使用のキーを削除するには

1. 管理センターで、サイドバーの「 アプリおよびインテグレーション」をクリックし、「API」>「Conversations API」を選択します。
2. 削除するビューにカーソルを合わせ、オプションメニュー（）をクリックして「削除」を選択します。
3. 「削除」をクリックして、操作を確定します。