外部 API 入门

本页面向您展示如何对 UiPath 进行首次经过身份验证的 API 调用。它将客户端凭据流程与机密外部应用程序一起使用——这是推荐的生产脚本、管理自动化和集成工作的起点。

备注：

选择正确的工具

UiPath Swagger 文档可让您探索可用的 API 端点，并在浏览器中以交互方式理解请求和响应格式。仅将 Swagger 用于发现和手动测试。对于生产自动化、脚本编写和集成，请使用 Postman、cURL 或您的应用程序代码，这些支持支持向 UiPath API 请求授权所需的完整 OAuth 2.0 持有者令牌流程。

先决条件

• UiPath 组织管理员已注册具有客户端凭据授予类型的机密外部应用程序，并为其分配了所需的作用域。
• 您具有已注册应用程序的应用程序 ID和应用程序密码。

有关注册外部应用程序和选择正确授权类型的信息，请参阅外部应用程序 (OAuth) 。

第 1 步：获取持有者令牌

向 Identity Server 令牌端点发送 POST 请求以接收持有者令牌。

curl -X POST "https://cloud.uipath.com/{organizationName}/identity_/connect/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials&client_id={app_id}&client_secret={app_secret}&scope={scopes}"

替换以下占位符：

占位符	值
{organizationName}	Automation Cloud URL 中显示的组织名称
{app_id}	外部应用程序注册中的应用程序 ID
{app_secret}	外部应用程序注册中的应用程序密码
{scopes}	已授予应用程序的作用域的空格分隔列表，例如: OR.Users.View PM.Users

响应返回持有者令牌：

{
    "access_token": "{access_token}",
    "expires_in": 3600,
    "token_type": "Bearer",
    "scope": "{scopes}"
}

复制access_token值。令牌有效期为一小时。

备注：

如果您使用的是 Postman 或类似工具，请将请求内容类型设置为application/x-www-form-urlencoded 。

步骤 2：调用 API 端点

请将持有者令牌包含在 API 请求的Authorization标头中。

以下示例从 Orchestrator 中检索计算机列表：

curl -X GET "https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Machines" \
  -H "Authorization: Bearer {access_token}" \
  -H "accept: application/json"

将{tenantName}替换为 Orchestrator 租户的名称，将{access_token}替换为步骤 1 中的令牌。

结果

成功请求将返回 HTTP 200，以及 JSON 格式的请求数据。

如果请求失败，请验证以下内容：

• 令牌未过期。令牌将在一小时后过期 — 重复第 1 步，请求新令牌。
• Authorization标头值的格式与Bearer {access_token}完全相同。
• 授予外部应用程序的作用域涵盖所请求的端点。要查找特定端点的作用域值，请查看本指南中的该端点的文档页面，特别是“平台管理 API”章节下。

后续步骤

• 有关所有 OAuth 授权类型和流程（包括用于用户委派访问的授权代码和 PKCE），请参阅外部应用程序 (OAuth) 。
• 有关身份验证中使用的所有 Identity Server 端点，请参阅UiPath Identity Server 端点。
• 要了解如何构建 API 端点 URL，请参阅API 端点 URL 结构。