Automation Anywhere

Automation Anywhere

關閉內容

內容

開啟內容

Enterprise 控制室驗證 API

  • 已更新:5/24/2019
    • 11.3.x
    • 探索
    • Enterprise
    • API 文件

Enterprise 控制室驗證 API

驗證 API 的優先順序高於所有 API,因此叫用第三方應用程式的使用者必須先進行驗證,才能使用下游 API。

為了操作 Control Room 資料以及從外部系統部署機器人,Enterprise 控制室 v.11.x 公開了公用 API。如此可讓第三方應用程式能夠使用 RPA、協調機器人,並根據事件管理 RPA 資料。例如,在 SAP 系統中建立使用者後,立刻建立 Automation Anywhere 使用者,或是在網域控制站中輪替密碼後,立刻在 Automation Anywhere 中更新登入認證。

驗證 API

API:v1/authentication

如果 Enterprise 控制室 URL 是 https://<your-control-room-url>,則 API 將會是 https://<your-control-room-url>/v1/authentication

此 API 會接受兩個必要參數及 1 個選擇性參數做為輸入 (採用 JSON 格式):

  • usernameAutomation Anywhere 使用者的使用者名稱。
  • passwordAutomation Anywhere 使用者的密碼。
  • 只有在 Enterprise 控制室 已設定單一登入 (SSO) 時,才需要 apiKey。如果您的 Enterprise 控制室 不使用 SSO,請移除此欄位。
{ "username": "string", "password": "string", "apiKey": "string" } 

例如:

  • Automation Anywhere 使用者名稱是 mike_williams
  • Automation Anywhere 密碼是 abc123
以下是未啟用 SSO 的 Enterprise 控制室 適用的 JSON 要求格式。
{ "username": "mike_williams", "password": "abc123" }

如果驗證成功,Enterprise 控制室 會發出驗證權杖,而此權杖必須傳遞至其他 Enterprise 控制室 API 做為標頭資訊。

註: 驗證權杖發出之後,有效時間只有 15 分鐘。

驗證 API 回應碼

Http 狀態碼 回應 說明
200
{ "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9. eyJ1c2VyIjoiMSIsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Qvd2ViY3 JzdmMvIiwiYXVkIjoiaHR0cDovL2xvY2FsaG9zdC93ZWJjcnN2Yy8iLCJle HAiOjE0OTUwOTAwOTksIm5iZiI6MTQ5NTA4OTE5OX0.qPPhpti0j7 LGAmWkj3XFymFfJXzA1P4zPehIjVYfulc" }
成功的驗證會傳回權杖。
401
{ "message": "Invalid credentials." }
  • 密碼無效。
  • 使用者不存在。
  • Acitive Directory (AD) 驗證認證無效。
401
{ "message": "Verify your email by clicking on the email verification link. This is mandatory as you will be able to login post verification only." }
電子郵件通知已啟用,但使用者尚未驗證其電子郵件地址。
402
{ "message": "License expired." }
一個或多個授權已過期。
403
 { "message": "Your account is not activated. Contact the admin." }
使用者的帳戶已停用。
傳送意見反饋