API 访问权限

概述

使用 Data Fabric/Data Service 开放 API，您可以从所选外部应用程序管理 UiPath ^™ Data Fabric/Data Service 资源，并且可以通过 Oauth 2.0 授权框架在不共享任何凭据的情况下授权外部应用程序。

了解如何注册外部应用程序。

API 权限

要使用 Data Fabric/Data Service OpenAPI，您必须向外部应用程序授予 API 权限。这些 API 权限称为作用域，Data Fabric/Data Service 分为三种类型：

• “Data Fabric/Data Service.Schema.Read ”- 此“用户作用域”允许您的外部应用程序读取租户的 Data Fabric/Data Service 架构，这取决于用户的权限。
• “Data Fabric/Data Service.Data.Read ”- 此用户作用域允许您的外部应用程序读取租户的 Data Fabric/Data Service 数据，这取决于用户的权限。
• “Data Fabric/Data Service.Data.Write ”- 此用户作用域允许外部应用程序通过删除、更新或创建新数据来编辑租户的 Data Fabric/Data Service 数据，并且这取决于用户的权限。

详细了解 Data Fabric/Data Service 中的用户角色和权限。

下载 OpenAPI 规范

为外部应用程序和用户设置权限后，下载租户 Data Fabric/Data Service 数据的 OpenAPI 规范：

• 在“Data Fabric/Data Service”页面上，选择“API 访问” ，然后选择“下载 OpenAPI 文件 (JSON)” 。

此操作将以 JSON 格式下载租户 Data Fabric/Data Service 实体的 OpenAPI 3.0 规范。

选择“复制 OpenAPI”链接，可复制生成租户 Data Fabric/Data Service OpenAPI 规范的 API 端点。

授权 API 调用

通过为外部应用程序创建访问令牌，授权您的外部应用程序使用 Data Fabric/Data Service OpenAPI。使用在外部应用程序注册时生成的应用程序 ID和应用程序密码。授权方法取决于应用程序的类型（机密或非机密）。

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

API 端点

OAuth2.0 授权框架可帮助您生成访问令牌，该令牌允许您的外部应用程序在有限的时间（一小时）内向 Data Fabric/Data Service 端点发出 REST API 调用。

要继续调用 API，您需要生成新的访问令牌或请求刷新令牌。

Data Fabric / Data Service API 端点具有以下语法：

• HTTP 方法+基本 URL +资源类别+ Data Fabric/Data Service 实体+操作+路径变量和查询参数

  

Data Fabric/Data Service 实体示例

为了描述每个 API 请求/响应正文，我们使用在 Data Fabric/Data Service 中创建的OCR实体字段。当我们记录通用端点（例如Get Entity Records ）时，端点将包含实体的确切名称（例如Get Olympics Records ）。响应正文和请求正文包含实体中的所有字段，以复制实体的结构。

此外，让我们使用 Data Fabric / Data Service API 指南来深入了解每个端点，并了解如何充分利用这些端点。