インテグレーションビルダーでカスタム認証を使用する

現在のプランを確認

アドオン	AIエージェント - Advanced

インテグレーションビルダーは、APIキー、ベアラートークン、ユーザー名とパスワード、OAuth 2.0など、標準の認証タイプをサポートしています。ただし、組織のニーズやワークフローによっては、標準の認証では不十分な場合があります。そのため、インテグレーションビルダーは、組織の認証および認証ソリューションと連携するカスタム認証専用インテグレーションというタイプもサポートしています。

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

• カスタム認証について
• カスタム認証を設定する
• カスタム認証をテストする

カスタム認証について

カスタム認証専用インテグレーションは、トークンとその有効期限をリクエストし、データまたはメインインテグレーションに渡して認証を受け、データに対するリクエストを実行します。

全体として、カスタム認証フローは次のとおりです。

1. 認証リクエスト。設定された認証専用インテグレーションは、アクセストークンの取得許可を求めるリクエストをサーバーに送信します。サーバーが（AIエージェント（Advanced）からの）リクエストを認証すると、アクセストークンとその有効期限（利用可能な場合）の取得が承認されます。
2. トークンの処理。サーバーがアクセストークンで応答した後、インテグレーションはトークンパラメータ自体と、トークンの有効期限を決定するexpiresInパラメータという2つの重要な情報を保存します。
3. データ統合にトークンを渡す。これら2つのパラメータ（トークンとexpiresIn）は、次のステップのデータインテグレーションに渡されます。トークンは、データインテグレーションによる後続のリクエストの認証に使用されます。トークンは内部で設定および処理され、セッションや会話のデータには公開されません。
4. データのカスタム認証リクエスト。アクセストークンが設定されると、会話を充実させるために必要なデータを取得するために、データインテグレーションが承認されます。

以下のフローチャートにカスタム認証フローを示します。

カスタム認証を設定する

インテグレーションビルダーでインテグレーションを作成する通常のプロセスの一環として、カスタム認証を設定します。

インテグレーションビルダーでカスタム認証を設定する手順

1. メインメニューで、「APIインテグレーション」をクリックします。
2. 右上の「インテグレーションを追加」をクリックします。
3. 「インテグレーションを追加」ウィンドウで以下を実行します。
   1. 「インテグレーション名」フィールドに、分かりやすい名前を付けます。
   2. （オプション）「説明」フィールドに、その目的を思い出せるように、インテグレーションの説明を入力します。
   3. 「認証のみ」のインテグレーションとして設定を選択します。
   4. 保存をクリックします。
      
4. 左側のサイドバーの「シナリオ」で、「エラー」にカーソルを合わせ、オプションメニュー（）を選択し、「削除」を選択します。カスタム認証には、成功シナリオのみが必要です。フォールバックシナリオは削除できません。
   
5. 「成功」シナリオページで、次の情報を含む2つのセッションパラメータを作成します（+ ボタンをクリック）。
   • トークン
     • キー：トークン（必ずこのように記述してください）
     • クエリ：トークンを定義する値を入力します。例：data.access_token
   • expiresIn
     • キー：expiresIn（必ずこのように記述してください）
     • クエリ：トークンの有効期限を定義する値を入力します。例：data.expires_in
       トークンの有効期限がデータのレスポンスに含まれない場合があります。その場合は、選択した値（秒単位で）をハードコード化できます。例：3600
       トークンの有効期限を設定することを強くお勧めします。テスト中にエラーが発生した場合は、これが新しいトークンが発行されるまでの待機時間です。トークンには有効期限がなく、無期限に設定できるため、トラブルシューティング時に新しいトークンを発行することはできません。
       
6. 通常どおりインテグレーションの作成を続行します。詳細については、インテグレーションビルダーの説明を参照してください。
7. 左側のサイドバーの「環境」で、環境（本番環境など）を選択します。
8. 「認証」タブの「認証タイプ」ドロップダウンフィールドで、「カスタム」を選択します。
9. 「API認証インテグレーション」ドロップダウンフィールドで、上記で作成したカスタム認証専用インテグレーションを選択します。
   
10. 「ヘッダー」タブを選択し、「ヘッダーを追加」をクリックします。
11. 次のフィールドに入力します。
    • キー：認証
    • 値：ベアラー {{apiToken}}（必ずこのように記述してください）
      
12. 保存をクリックします。

カスタム認証をテストする

カスタム認証専用インテグレーションを設定した後、テストすることをお勧めします。詳細については、機能テストを参照してください。

トラブルシューティングstatusCode：null

さらに、インテグレーションをテストする際、以下の画像のように「statusCode: null」メッセージが表示されることがあります。

まず、カスタム認証専用インテグレーションが上記ステップに従って正しく設定されていることを再確認します。

次に、エラーが発生している箇所をメモします。エラーが認証インテグレーションで発生している場合、何かが正しく設定されていないか、リクエスト先のURLが間違っている可能性があります。この場合、問題について詳しい情報を入手できる可能性があるため、自社のエンジニアに調査を依頼することをお勧めします。

上記のステップを実行しても、このエラーが発生する場合は、トークンの有効期限が切れるまで待ってから、もう一度やり直してください。

これらのトラブルシューティングのすべてのステップを試してもインテグレーションが機能しない場合は、CSMに連絡して追加のサポートを依頼してください。