ウェブ リクエスト - ベータ版

ボット内で使用する情報を取得する、あるいは外部システム内の変化を駆動させるには、ウェブ リクエスト ステージを使用します。 このステージは Ivanti Neurons プラットフォームから実行され、ステージを通過するデバイス1台につき1回実行されます。 このステージは、サードパーティの REST API と対話でき、未認証 API と認証済み API に対してサポートされています。

ウェブ リクエスト ステージの構成方法

1. [ボットの作成] ページで、[ウェブ リクエスト] ステージをボットに追加し、[ステージ設定] を開きます。
2. ウェブ リクエストに認証が必要な場合は、[資格情報の選択] ドロップダウンから認証資格情報を選択します。 新しい資格情報を作成する必要がある場合は、[認証資格情報を追加] をクリックして [資格情報ストア] を開きます。 現在は、API の基本認証と API キーによる認証がサポートされています。 認証資格情報が必要ない場合は、既定の設定 [認証なし] のままにしておきます。
3. 自動生成されたヘッダーを表示したい場合は、[ヘッダー] の下で [自動生成されたヘッダーを表示] を [オン] にします。 ヘッダーはターゲット API の必要条件に準じます。詳細については、サードパーティのドキュメントをご参照ください。
   • キー: ウェブ リクエストのヘッダー キーを入力します。
   • 値: ウェブ リクエストのヘッダー値を入力します。
4. 方法を選択します。 これは、ターゲット API にアクセスするために使用される HTTP 方法です。 サポート対象の方法は、GET、POST、PUT、PATCH、および DELETE です。
5. API アドレスを入力します。 このアドレスにはインターネットでアクセスできることが必要です。
   別のステージまたはボット入力から値を渡す場合や、宛先 API が JSON ペイロードを受け入れる場合は、[JSON 本文を編集] をクリックして JSON エディタを開きます。 含める値を選択します (情報が渡されるためには、[ウェブ リクエスト] ステージが前の任意のステージに接続されている必要があります)。
   
6. API からの応答を反映した適切な出力モードを選択します。 HTTP 方法として GET を選択する場合、最も一般的なのは JSON です。
7. [テストして応答を取得] をクリックして、API の即時呼び出しを行います。
   JSON 本文に前のほうのステージからの変数が含まれている場合は、サンプル データの入力を求められます。
8. [サンプル応答] には、「テストして応答を取得」アクションから自動入力されます。
   応答を検証できれば、結果が単数なのか (エンドポイントごとに一意のフィールド)、配列なのか (エンドポイントごとに所定のフィールド1つに対して複数の値) を判別できます。
9. 結果が配列である場合は、[マッピング配列] をオンに切り替える必要があります。
   このステージがマッピング配列モードである場合は、ステージに「複数」のバッジが表示されます。これは、結果を他の大半のステージで使用するためには、結果ごとに内容を実行するための「for-each」ブロックを使用する必要があることを意味しています。
   • [配列のパス] を入力します。
10. [マッピング配列] トグルを [オン] にした後、次の [フィールド マップ] 属性を入力します。
    • 配列要素内のパス: JSON 応答内のオブジェクトへのパス。 これは、単純にその独自の名前でかまいませんが、オブジェクトがネストされている場合は、パスをドット構文で示す必要があります。例: level1.level2.myfield
      単数の例:
      {"configuration": {startup_events": {"updates": "some value"}}}
      更新へのパスは次のようになります: configuration.startup_events.updates
      配列の例:
      {"users": [{display_info": {"name": "John"}}]}
      配列へのパスは次のようになります: users
      配列内のパスは次のようになります: display_info.name
    • タイプ: これは、将来のステージで正しいフィルタ/動作を適用できるように、読み取られる値の形式と一致している必要があります。
    • マップされたラベル: これは、後続のステージでトークン ピッカーやフィルタに表示される、フィールドのわかりやすい名前です。

マッピング配列属性を選択した後は、[マッピングをテスト] をクリックして、サンプル応答に対してマッピングをテストします。これにより、マッピングが正しいことが確認されます。