automation-cloud
latest
false
重要 :
请注意此内容已使用机器翻译进行了部分本地化。
UiPath logo, featuring letters U and I in white
Automation Cloud API 指南
Last updated 2024年11月19日

API 密钥

您可以使用 API 密钥在 UiPath™ Platform 和 UiPath™ Platform 外部的其他应用程序之间建立连接。外部应用程序可以是 UiPath 桌面应用程序,也可以是第三方应用程序。

API 密钥可用于多个 UiPath 服务(产品)。

重要提示: 2025 年 3 月将终止对 API 密钥身份验证的支持。 我们建议使用外部应用程序个人访问令牌 (PAT)作为主要的身份验证方法。

了解有关即将弃用的内容的更多信息。

Orchestrator

关于 API 访问权限

您可以在“管理员”>“租户”>“服务”页面上查看每个现有 Orchestrator 服务的 API 访问权限信息。

通过 API 调用对 Automation Cloud 中的 Orchestrator 服务进行身份验证时,需要使用此信息。

注意:如果您无权访问“管理员”页面,则该页面仅适用于具有组织管理员角色的用户。您可以从帐户的“首选项”页面获取 API 访问权限信息。
重要提示:

不适用于 Azure AD

如果组织的身份验证设置设为使用目录集成,则“API 访问权限”按钮将不可用,并且相关说明对您不适用。

在此情况下,您必须执行以下某项操作:

  • 从 Automation Cloud 中注销,然后使用 UiPath™ 帐户而非目录帐户登录,或者
  • (推荐)改用 OAuth 流程

查看 API 访问权限信息

如果您具有组织管理员角色,或者已被分配到该服务,则可以查看相应服务的 API 访问权限信息。

  1. 导航到“管理员”,然后在左侧面板中选择租户。
  2. 单击“服务”

    系统将打开“服务”页面,其中列出所选租户的所有现有服务。

  3. 单击 Orchestrator 卡上的 docs image,然后选择“API 访问权限”:


    系统将显示“API 访问”窗口,其中包含以下特定于服务的信息:

    • 用户密钥 - 使您能够生成用于 API 或外部应用程序的唯一登录密钥,以便代表您登录和执行操作。以前称为刷新令牌
    • 账户逻辑名称 - 您的组织名称(例如 myNewOrg)。
    • 租户名称 - 租户的显示名称。
    • 客户端 ID - 特定于 Orchestrator 应用程序本身,对于特定平台上的所有用户和 Orchestrator 服务均相同。例如,cloud.uipath.com 上的所有 Orchestrator 服务都具有相同的客户端 ID 值。
  4. 单击任何字段旁边的 docs image 图标,以复制其值。


您可以使用复制的信息来使用云 API

撤销 API 访问权限

撤销访问权限会取消先前分配的所有用户密钥,从而破坏依赖于先前所分配用户密钥的所有应用程序。系统会自动为所选的 Orchestrator 服务生成新的用户密钥。

您需要将新的用户密钥传达给所有受影响的应用程序。

  1. 导航到“管理员”,然后在左侧面板中选择租户。
  2. 单击“服务”

    系统将打开“服务”页面,其中列出所选租户的所有现有服务。

  3. 单击 Orchestrator 卡上的 docs image,然后选择“API 访问权限”。

    系统将打开“API 访问权限”窗口。

  4. 单击“撤销访问权限”。

    确认窗口将打开。

  5. 单击“撤销”以确认您的操作。

    系统将撤销服务的“用户密钥”值,并显示“已撤销刷新令牌”窗口。

  6. 关闭“已撤销刷新令牌”窗口。
  7. 复制新密钥并将其与需要的用户共享。

Document Understanding

可在“管理员”>“许可证”>“消耗品”>“AI Unit”页面上找到 Document Understanding 的 API 密钥:



从此处,您可以:

  • 复制密钥以在外部应用程序中使用。
  • 单击“刷新”图标以生成新密钥。
    重要提示:生成新密钥会使旧密钥无效。任何使用旧密钥的外部应用程序将无法再连接到 Automation Cloud。

如需更多信息,请参阅 Document Understanding 文档中的 API 密钥

Computer Vision

可在“管理员”>“组织”>“许可证”>“机器人和服务”页面上找到计算机视觉的 API 密钥。



从此处,您可以:

  • 复制密钥以在外部应用程序中使用。
  • 单击“刷新”图标以生成新密钥。

    重要提示:生成新密钥会使旧密钥无效。任何使用旧密钥的外部应用程序将无法再连接到 Automation Cloud。

如需更多信息,请参阅 Computer Vision

  • Orchestrator
  • 关于 API 访问权限
  • 查看 API 访问权限信息
  • 撤销 API 访问权限
  • Document Understanding
  • Computer Vision

此页面有帮助吗?

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