orchestrator
latest
false
  • 入门指南
  • Swagger 定义
    • 读取我
    • 在 Swagger 中授权 API 调用
    • 管理逻辑资源
  • Orchestrator API
Orchestrator API 指南
Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated 2024年10月23日

在 Swagger 中授权 API 调用

访问 Swagger

如果您使用 Swagger 试用我们的 API,只需在单独的选项卡中登录 Orchestrator 实例即可。

可以通过将 /swagger/ui/index#/ 后缀添加到 Orchestrator URL 来访问 Orchestrator API Swagger 定义。例如,https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_ /swagger/ui/index#/
注意: 根据在 Orchestrator 实例中设置的参数,Swagger 身份验证是否过期。 默认情况下,该时间设置为 30 分钟。 您可以通过修改 Web.config 文件中 Auth.Cookie.Expire 参数的值来更改此参数。

获取访问令牌

要通过 Swagger 用户界面为 Orchestrator 服务授权 API 调用,请执行以下步骤:

  1. 在 Orchestrator API 页面的右上角找到“授权”按钮。如果锁是打开的,则表示您未经授权。



  2. 单击 “授权”。 系统将显示“ 可用权限 ” 窗口。

    注意: 我们目前支持一种称为 OAuth2 的授权方案。


  3. 系统会预先选择所有作用域,以便您可以在 Orchestrator API 中试验所有端点。 如果要限制对某些 API 的访问,请清除它们。
  4. 单击 “授权”。 系统将显示一个新窗口,确认您已获得授权。
  5. 完成后,单击 “关闭”X 以关闭“ 可用的授权 ” 窗口。 “ 授权 ”按钮显示关闭的锁,表示您已获得授权。

发送请求

获得授权后,您可以对 Orchestrator API 资源发出请求,如下所示:

  1. 展开要用于执行操作的 Orchestrator API 资源。 已关闭的锁定表示您已获得授权。


  2. 在展开的方法窗口中,单击“ 试用” 。
  3. 根据需要指定参数值。
  4. 单击 “执行”。 请求已执行。 不记名授权标头将自动用于您的请求。


生成新的访问令牌

当访问令牌过期时,您会收到 401: You are not authenticated! 响应。 您的请求仍存在不记名授权标头,但访问令牌已过期。 发生这种情况时,您需要使过期的令牌失效并生成新的访问令牌:
  1. 在 Orchestrator API 页面的右上角找到“授权”按钮。锁应该已关闭。


  2. 单击“ 授权 ”,然后在显示的“ 可用授权 ”页面上,单击“ 注销 ”以撤销过期的令牌。


  3. 单击“关闭”或 X 以关闭“可用的授权”窗口,然后按照“获取访问令牌” 部分中的说明获取访问令牌。

撤销访问权限

使用完 Swagger 用户界面后,您应该使已使用的访问令牌失效:

  1. 在 Orchestrator API 页面的右上角找到“授权”按钮。锁应该已关闭,表示您已获得授权。
  2. 单击“ 授权 ”,然后在显示的“ 可用授权 ” 页面上单击“ 注销”。
  3. 单击 “关闭”X以关闭“可用的权限” 窗口。 “ 授权 ”按钮显示打开的锁,表示您未经授权。

此页面有帮助吗?

获取您需要的帮助
了解 RPA - 自动化课程
UiPath Community 论坛
Uipath Logo White
信任与安全
© 2005-2024 UiPath。保留所有权利。