インテグレーションビルダーは、APIキー、Bearerトークン、ユーザー名とパスワード、OAuth 2.0などの標準的な認証タイプに対応しています。ただし、組織のニーズやワークフローによっては、標準的な認証だけでは不十分な場合があります。そのため、インテグレーションビルダーでは、組織の認証および認可ソリューションと連携する「カスタム認証専用」インテグレーションタイプもサポートされています。
この記事では、次のトピックについて説明します。
カスタム認証について
カスタム認証専用インテグレーションは、トークンとその有効期限をリクエストし、それをデータインテグレーションまたはメインインテグレーションに渡します。これにより、データインテグレーションまたはメインインテグレーションは認可を受けたうえで、データをリクエストできます。
カスタム認証フローの全体の流れは、次のようになります。
- 認可リクエスト。設定済みの認証専用インテグレーションは、アクセストークンの取得許可を求めるリクエストをサーバーに送信します。サーバーがAIエージェントからのリクエストを認証すると、アクセストークンの取得を許可し、利用可能な場合はその有効期限も返します。
- トークンの処理。サーバーがアクセストークンを返すと、インテグレーションは2つの重要な情報を保存します。token パラメータ自体と、トークンの有効期間を決定する expiresIn パラメータです。
- データインテグレーションへのトークンの引き渡し。これら2つのパラメータ(token と expiresIn)は、次のステップであるデータインテグレーションに渡されます。トークンは、データインテグレーションによる後続のリクエストを認証するために使用されます。トークンは内部で設定および処理され、セッションデータや会話データに公開されることはありません。
- データに対するカスタム認可リクエスト。アクセストークンが設定されると、データインテグレーションは必要なデータを取得する認可を受けます。このデータは、会話を充実させるために使用されます。
以下のフローチャートに、カスタム認証フローを示します。

カスタム認証の設定
カスタム認証は、インテグレーションビルダーでインテグレーションを作成する通常のプロセスの一環として設定します。
インテグレーションビルダーでカスタム認証を設定するには
- メインメニューで、「APIインテグレーション」をクリックします。
- 画面右上にある「インテグレーションを追加」をクリックします。
- 「インテグレーションを追加」ウィンドウで、次の操作を行います。
- 「インテグレーション名」フィールドに、何のインテグレーションがわかるような名前を入力します。
- (オプション)「説明」フィールドに、そのインテグレーションの用途がわかる説明を入力します。
- 「「認証のみ」のインテグレーションとして設定」を選択します。
- 「保存」をクリックします。
- 左側のサイドバーの「シナリオ」で、「失敗」にカーソルを合わせ、オプションメニュー(
)から「削除」を選択します。カスタム認証では、「成功」シナリオのみが必要です。「フォールバック」シナリオは削除できません。
- 「成功」シナリオページで、+ ボタンをクリックし、以下の詳細を指定して2つのセッションパラメータを作成します。
- token
- キー:token(この表記どおりに正確に入力する必要があります)
- クエリ:トークンを定義する値を入力します。例:data.access_token
- expiresIn
- キー:expiresIn(この表記どおりに正確に入力する必要があります)
-
クエリ:トークンの有効期限を定義する値を入力します。例:data.expires_in
データレスポンスにトークンの有効期限が含まれていない場合があります。その場合は、任意の値を秒単位でハードコードできます。以下はその例です。3600
トークンの有効期限を設定することを推奨します。テスト中にエラーが発生した場合、新しいトークンが発行されるまで、ここで設定した時間だけ待つ必要があります。有効期限を設定しない場合、トークンは無期限に設定されるため、トラブルシューティング中に新しいトークンを発行できなくなります。
- token
- 「保存」をクリックします。
データインテグレーションの作成
次に、上述の手順で作成したカスタム認証専用インテグレーションを使用するデータインテグレーションを作成します。これは、新しいインテグレーションを作成する場合と同じ手順で行います。詳細については、「インテグレーションビルダーの解説」を参照してください。
データインテグレーションを作成するには
- 左側のサイドバーの「環境」で、環境(「本番環境」など)を選択します。
- 「認証」タブでの「認証タイプ」ドロップダウンフィールドで、「カスタム」を選択します。
- 「API認証インテグレーション」ドロップダウンフィールドで、上記で作成したカスタム認証専用インテグレーションを選択します。
- 「ヘッダー」タブを選択し、「ヘッダーを追加」をクリックします。
- 次のフィールドに入力します。
- キー:Authorization
-
値:Bearer {{apiToken}} (この表記どおりに正確に入力する必要があります)
- 「保存」をクリックします。
カスタム認証のテスト
カスタム認証専用インテグレーションの設定が完了したら、テストすることをお勧めします。詳細については、「機能テスト」を参照してください。
「statusCode: null」のトラブルシューティング
また、インテグレーションのテスト中に、以下の画像のように「statusCode: null」というメッセージが表示される場合があります。
まず、上記の手順に従ってカスタム認証専用インテグレーションが正しく設定されているか、再度確認してください。
次に、エラーの発生箇所を確認します。認証インテグレーションで発生している場合は、設定に誤りがあるか、リクエスト先のURLが間違っている可能性があります。この場合は、問題の原因についてより詳しい情報を得られる可能性があるため、自社のエンジニアに確認することをお勧めします。
上記の手順を実行してもこのエラーが発生する場合は、トークンの有効期限が切れるまで待ってから、再試行してください。
これらのトラブルシューティング手順をすべて試してもインテグレーションが機能しない場合は、担当のCSMにお問い合わせください。