Web 要求 - 測試版

使用 Web 要求階段可擷取要在機器人內使用的資訊,或驅動外部系統中的變更。 此階段從 Ivanti Neurons 平台執行,並在每個經過該階段的裝置上執行一次。 它可以與第 3 方 REST API 互動,且支援未經驗證和經過驗證的 API。

如何設定 Web 要求階段

  1. 在「建立機器人」頁面上,將 Web 要求階段新增至機器人並開啟階段設定
  2. 如果 Web 要求需要驗證,請從選取認證下拉式清單中選取認證。 如果您需要建立新認證,請按一下新增認證以開啟認證存放區。 目前支援基本 API 和 API 金鑰驗證。 如果不需要認證,請將預設設定保留為不進行身分驗證
  3. 如果您想檢視自動產生的標頭,請在標頭下方,將顯示自動產生的標頭切換為開啟。 標頭符合目標 API 需求,如需詳細資訊,請參閱第 3 方文件。
    • 金鑰: 輸入 Web 要求的標頭金鑰。
    • : 輸入 Web 要求的標頭值。
  4. 選取方法。 這是將用來存取目標 API 的 HTTP 方法。 支援的方法有: GET、POST、PUT、PATCH 和 DELETE。
  5. 輸入 API 位址。 該位址必須可透過網際網路存取。
    如果您從另一個階段或機器人輸入傳入值,且目標 API 接受 JSON 負載,請按一下編輯 JSON 正文以開啟 Json 編輯器。 選取要包含的值 (Web 要求階段必須連接到任何先前階段,才能傳遞資訊)。
  6. 選擇適當的輸出模式以反映 API 的回應。 如果您已選取 GET 的 HTTP 方法,最常見的將是 JSON。
  7. 按一下測試並取得回應,以立即呼叫 API。
    如果 JSON 正文包含早期階段的變數,系統會提示您輸入範例資料。
  8. 會從「測試並取得回應」動作填入範例回應
    驗證回應後,您可以確定結果是單一結果 (每個端點的欄位均為唯一值) 還是陣列 (每個端點指定欄位有多個值)。
  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
    • 類型: 這需要與讀取之值的格式相符,以便可以在未來階段套用正確的篩選器/行為。
    • 對應標籤: 這會是在後續階段中權杖選擇器和篩選器上顯示的欄位易記名稱。

選取「對應陣列」屬性之後,按一下測試對應,以針對「範例回應」測試對應,如此可確保對應正確。