API アクセス申請
Bright Pattern コンタクトセンター API へのアクセス権をアプリケーションに付与するには、こちらでアプリケーションを登録してください。各アプリケーションは、生成された認証情報とアクセストークンを使用して認証を行い、関連付けられたユーザーに代わって動作するため、その API アクセスには当該ユーザーのアクセス権が適用されます。
このページには、API アクセス権が付与されたアプリケーションがリスト表示されており、登録の追加、確認、編集、削除を行うことができます。
登録済みの各アプリケーションには、名前、クライアント ID、関連ユーザー、アクセストークンの有効期間が表示されます。アプリケーションを編集または削除するには、行の末尾にあるアクションメニュー（⋮）を使用してください。
アプリケーションの追加
[アプリケーションの追加] をクリックして、[アプリケーションの追加] ダイアログを開きます。
以下の情報を入力し、[追加] をクリックしてください：
名前
アプリケーションを識別するための名前です。これは必須項目ですが、後で変更することができます。
関連ユーザー
アプリケーションの API 呼び出しに適用されるアクセス権を持つユーザーアカウントです。これは必須項目です。リストからユーザーを選択してください。作成後も関連ユーザーを変更できます。
アクセストークンの有効期間
このアプリケーションに発行されたアクセストークンの有効期間です。数値を入力し、単位を選択してください。既定は6ヶ月、最大は12ヶ月、最小は1時間です。作成後もこの値を変更できます。
アプリケーションの詳細の確認
アプリケーションを追加すると、「アプリケーションの詳細を確認」ダイアログが表示されます。このダイアログには、「関連ユーザー」や「アクセストークンの有効期間」など、入力した値に加え、生成された認証情報、およびアクセストークンをリクエストするためのボタンが表示されます。
クライアント ID
アプリケーション用に生成された識別子（26桁の英数字）です。自動的に作成され、変更することはできません。クライアントシークレットと組み合わせて、アプリケーションの認証に使用されます。「コピー」ボタンを使用してコピーしてください。
クライアントシークレット
トークンをリクエストする際に、アプリケーションがクライアント ID と組み合わせて認証に使用する、生成されたシークレットです。
|
クライアントシークレットは、作成時に一度だけ表示されます。ダイアログを閉じる前に、これをコピーして安全に保管してください。その後、テーブル上でもアプリケーションの編集時でも、再度表示することはできません。 | |
アクセストークン
アクセストークンとは、アプリケーションが認証のために API リクエストに含めるベアラートークンのことです。これは関連ユーザーに紐付けられているため、これを使用して行われるリクエストにはそのユーザーのアクセス権が反映され、「アクセストークンの有効期間」の間有効です。
アクセストークンは、アプリケーションの作成時に自動的に生成されるものではありません。[アクセストークンをリクエスト] をクリックして生成してください。これは、アプリケーション作成時にクライアントシークレットが生成されるのと同じ手順です。アクセストークンは、アプリケーション作成直後にこのダイアログからのみリクエストできます。
|
|
アクセストークンをコピーできる機会は一度だけです。クライアントシークレットと同様に、表示されるのは一度きりです。その後は取得できないため、ダイアログを閉じる前にコピーして安全に保管してください。「表示」ボタンでトークンを表示し、「コピー」ボタンでコピーしてください。 | |
アプリケーションの編集と削除
アプリケーションの行にあるアクションメニュー（⋮）を使用して、編集または削除を行ってください。既存のアプリケーションについては、「名前」、「関連ユーザー」、および「アクセストークンの有効期間」を変更できます。ただし、クライアント ID は変更できません。また、クライアントシークレットとアクセストークンは、作成後は再度表示することはできません。
API アプリケーションを削除すると、その API へのアクセスは終了し、すべてのトークンが無効になります。アプリケーションを削除する前に、確認のメッセージが表示されます。