閱讀及檢閱 Automation Anywhere 文件

Automation Anywhere Automation 360

關閉內容

內容

開啟內容

REST Web Service package

  • 已更新:2022/02/20
    • Automation 360 v.x
    • 組建
    • RPA 工作區

REST Web Service package

使用 REST Web Servicepackage中的actions作為傳送要求和接收 API 回應的方法 (刪除、取得、修補、發佈或放置)。

使用 REST Web Serviceactions

提供下列資訊以傳送 REST 要求並收到回應。並非所有方法都需要全部參數。
  • [URI]:API 資源的唯一位址。
  • [驗證模式]:支援三種驗證模式:
    • [基本]:文字字串可用於基本驗證。
    • [登入的 AD 使用者]:得到授權存取相關 API 的 Active Directory (AD) 使用者,會透過 AD 進行驗證。要求中不需要認證。
    • Windows NT LAN 管理員 (NTLM) 驗證 (AD 使用者):這是一種可讓用戶端以加密認證或純文字形式,提供使用者名稱和密碼的挑戰/回應驗證方法。我們建議您使用儲存在 Automation Anywhere Credential Vault中的認證。
  • [標頭]:並非所有方法都需要標頭。標頭代表與要求相關的中繼資料。
    註: 若要在您的要求中使用 API 金鑰,請在標頭 [名稱] 欄位中輸入 api_key,然後在 [] 欄位中輸入金鑰值。
  • [擷取失敗回應]:選取核取方塊以擷取故障回應,但 [成功/確定] 回應除外。故障回應的詳細資料可在回應本文中擷取。
  • [使用 https 時允許不安全的連線]:選取此核取方塊可在使用 https 時允許不安全的連線。
  • [內容類型]:當標頭包含內容類型時,會定義用戶端與伺服器之間的內容協商。REST Web Serviceactions支援以下內容類型:
    • application/json
    • application/xml
    • text/plain
    • text/html
    • text/xml
    • multipart/form-data
  • [等候動作完成]:您可以設定在傳送 REST 要求並收到回應時的逾時值。執行例如發佈、放置、刪除、修補和取得等actions時,在 [等候動作完成] 欄位中,您可以指定等候時間 (毫秒)。依預設,等候時間為 60000 毫秒。
  • [輸出變數]:回應輸出會以字典變數擷取。字典變數為金鑰值配對。使用回應標頭名稱作為金鑰以傳回標頭值,或使用「本文」作為傳回回應本文的金鑰。
    註: 具有其值的回應金鑰可在字典變數中取得,以顯示 REST API 的回應狀態。
    若要取得 API 資源的標頭名稱清單,請執行下列步驟:
    1. 請在 REST Web Service action之後插入Loop action
    2. 選取 [字典中的每個索引鍵] 迭代器。
    3. 在 [字典變數] 欄位中,選取保留 REST Web Serviceaction輸出的變數。
    4. 將每個金鑰的值指派給 $Prompt-assignment$
    5. 插入Log To Fileaction
    6. 提供文字檔案的檔案路徑,以保存標頭名稱清單。
    7. 在 [輸入要記錄的文字] 欄位中插入 $prompt-assignment$
    8. 選取 [覆寫現有檔案] 選項。
    9. 按一下 [儲存]

      執行bot時,會從 API 資源列印標頭名稱至選取的檔案。

安全地傳遞值

您可以藉由指定下列所支援action欄位中的locker、認證和屬性,以安全的方式將值從Credential Vault傳遞至網頁服務:
  • URI
  • 自訂標頭
  • 本文:針對 application/x-www-form-urlencoded 內容類型,按一下 [新增參數] 以從Credential Vault選取值。

    對於所有其他內容類型,請選取 [選取認證作為參數] 選項,然後按一下 [挑選]。

REST Web Servicepackage中的Actions

Action 說明
Delete 方法 移除 URI 所識別的資源。
Get 方法 擷取 URI 內包含的參數所識別的資訊。GET 方法沒有 [內容類型],因為所有參數會作為 URI 的一部分傳遞。

[GET] 方法的限制和特性包括下列項目:

  • URI 長度限制為 2048 個字元。
  • 所有參數皆會在 URI 中傳遞。
  • [GET] 方法會揭露 URI 中的資料,使其安全性比 [POST] 方法低。
  • [GET] 不會變更任何資料,因此不論授權與否,對所有使用者來說都能安全無虞。
Patch 方法 修改 URI 所識別的資源。
Post 方法 在 URI 中建立新資源。
  • 參數會在要求本文中傳遞。
  • 要求本文沒有長度限制。
Put 方法 根據 URI 或本文傳遞的參數更新或取代資源。

Proxy 支援

如果您的裝置已設定 Proxy,則所有來自此package的輸出要求都會透過 Proxy 伺服器來路由。請參閱將Bot agent連線至具備 Proxy 的裝置

傳送意見反饋