UiPath Documentation
integration-service
latest
false
Integration Service 用户指南
重要 :
请注意,此内容已使用机器翻译进行了本地化。 Integration Service 中提供的连接器包采用的是机器翻译的译文。 新发布内容的本地化可能需要 1-2 周的时间才能完成。

API 访问权限

使用 OAuth 2.0 授权和 Integration Service 作用域,从外部应用程序调用 Integration Service API。

概述​

Integration Service API 允许您从所选外部应用程序中使用 Integration Service 资源。您可以通过 OAuth 2.0 框架授权应用程序,因此服务或脚本可以自行进行身份验证,而无需依赖已登录的用户会话,并且无需共享任何凭据。

使用它,您可以从发布或部署引用自定义连接器的解决方案的 CI/CD 管道中调用 Integration Service,或在需要在用户未登录的情况下创建或管理自身 Integration Service 连接的编码应用程序或智能体中调用 Integration Service。

访问权限仅限于您授予的作用域内。外部应用程序或通过外部应用程序进行操作的用户不能超出这些权限。使用用户令牌的现有 API 访问保持不变。

API 权限​

要调用 Integration Service API,您必须向外部应用程序授予 API 权限。这些权限称为作用域。通过将Integration Service添加为资源,在 Automation Cloud 中的“管理员”>“外部应用程序”下进行添加。

范围授权可用形式
IS.Connections.Read连接的读取权限。用户作用域
IS.Connectors.Read对连接器的读取权限,包括下载自定义连接器。用户作用域、应用程序作用域
IS.连接器.导出未使用。没有端点需要此作用域。不适用
重要提示:

IS.Connections.Read仅具有用户作用域。对于在没有用户登录情况下自行进行身份验证的外部应用程序,无法授予此权限。

非机密应用程序只能被授予用户作用域。有关应用程序类型之间以及用户作用域和应用程序作用域之间的区别,请参阅授权外部应用程序。

授权 API 调用​

通过为外部应用程序创建访问令牌来对其进行授权。使用注册应用程序时生成的应用程序 ID和应用程序密码。授权方法取决于应用程序的类型:机密或非机密。

详细了解外部应用程序的授权方法。

将该令牌作为持有者令牌发送给您的请求。令牌的有效期为一小时。要在此之后继续调用 API,请生成新的访问令牌或请求刷新令牌。

文件夹范围​

外部应用程序必须使用X-UIPATH-FolderKey标头将每个请求定位为单个文件夹,并且需要该文件夹的Connections.View权限。省略标头的请求以及询问所有文件夹的请求将被拒绝。

如果连接与目标文件夹不同,则连接将报告为“未找到”,而不是“禁止”。

可用端点​

API 指南当前记录了以下端点:

对外部应用程序的响应将省略连接所有者、元素实例 ID、轮询间隔和“自带应用程序”标志。连接配置仅会返回给拥有配置读取作用域的调用者,而且永远不会返回 API 密钥和 OAuth 令牌等机密信息。

有关每个端点的详细信息,请参阅Integration Service API 指南。

  • 概述​
  • API 权限​
  • 授权 API 调用​
  • 文件夹范围​
  • 可用端点​

此页面有帮助吗?

连接

需要帮助? 支持

想要了解详细内容? UiPath Academy

有问题? UiPath 论坛

保持更新