受信通信用のメッセージ認証の設定

基本認証または OAuth 認証の代わりに仮想エージェント API のメッセージ認証を設定できます。メッセージ認証には、静的トークンまたはハッシュトークンの設定、プロバイダー認証の設定、およびチャネル ID の設定が含まれます。

始める前に

「受信 REST エンドポイントの確認と受信認証の構成」の手順に従ってください。

必要なロール：admin

手順

1. トークンタイプに応じて、次のいずれかを実行し、トークンを構成します。
   • 静的トークン：
     1. [すべて] に移動して、フィルターに「token_verification.list」と入力します。
     2. [新規] をクリックします。
     3. [トークン検証] フォームで、フィールドに入力します。

        フィールド	説明
        名前	認証トークンの名前 (B2BTestAppAuthToken など)。
        説明	認証トークンの説明 (B2B テストアプリケーション認証トークンなど)。
        トークン	一般的なプログラミング言語またはスクリプティング言語を使用して生成した認証トークンを入力するか、関連リンクの [保護トークンを生成] をクリックします。

     4. [送信] をクリックします。
   • ハッシュトークン：
     1. [すべて] に移動し、フィルターに「hash_message_verification.list」と入力します。
     2. [新規] をクリックします。
     3. [ハッシュメッセージの検証] フォームで、フィールドに入力します。

        フィールド	説明
        名前	認証トークンの名前 (B2BTestAppAuthToken など)。
        説明	認証トークンの説明 (B2B テストアプリケーション認証トークンなど)。
        シークレット	認証トークン (ランダムな文字列)。

     4. [送信] をクリックします。
2. トークンベース認証のプロバイダー認証を設定します。
   1. [すべて] に移動して、フィルターに「message_auth.list」と入力します。
   2. [新規] をクリックします。
   3. [メッセージ認証] フォームで、フィールドに入力します。

      フィールド	説明
      名前	メッセージ認証の名前 (B2B Auth トークンなど)。
      プロバイダー	プロバイダーの名前。
      グループ名	必須ではありません。
      サービスポータル	必須ではありません。
      着信メッセージの検証	作成した静的トークンまたはハッシュメッセージトークンを選択します。
      送信メッセージの作成	このフィールドは、現在仮想エージェント API ではサポートされていません。作成した静的トークンまたはハッシュメッセージトークンを選択します。
      送信サービスのトークン	このフィールドは、現在仮想エージェント API ではサポートされていません。

   4. [送信] をクリックします。
3. チャネル ID を設定します。
   1. [すべて] に移動して、フィルターに「sys_cs_provider_application.list」と入力します。
   2. VA ボット間プロバイダーアプリケーションレコードを選択して開きます。
   3. [プロバイダーチャネル ID] フォームで [メッセージ認証] フィールドを探し、前に設定したメッセージ認証を選択します。

      

   4. [更新] をクリックします。
4. ハッシュトークンベースの認証のみの場合、要求ヘッダーで x-b2b-signature を送信します。
   値は要求ペイロードの HmacSHA1 エンコード値で、ServiceNow インスタンスで作成されたトークンを使用します。たとえば、Postman で次の手順を実行します。
   1. ヘッダーで、x-b2b-signature を {{hashValue}} に設定します。

      

   2. [事前要求スクリプト (Pre-request Script)] エリアで、次のようにトークンを設定します。

      pm.environment.set('hashValue', CryptoJS.HmacSHA1(JSON.stringify(JSON.parse(request.data)), '<insert your token>').toString(CryptoJS.enc.Hex));

      

次のタスク

仮想エージェント API の出力応答 REST エンドポイントと送信認証の構成