API 访问权限

概述

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

Learn how to register the external application in UiPath^® Automation Suite.

API 权限

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

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

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

下载 OpenAPI 规范

设置了外部应用程序和用户权限后，您就可以下载租户 Data Service 数据的 OpenAPI 规范。为此，请导航至租户的“Data Service”选项卡右上角的菜单 >“API 访问”>“下载 OpenAPI 文件 (JSON)”。

这样可以获取租户 Data Service 实体的 OpenAPI 3.0 规范（JSON 格式）。单击“复制 OpenAPI 链接”后，系统会复制用于生成租户 Data Service OpenAPI 规范的 API 端点。

授权 API 调用

要访问 Data Service 的用户范围资源，请使用以下方法之一授权您的外部应用程序：

• 授权代码（用于机密外部应用程序）

• 使用 PCKE 的授权代码（用于非机密外部应用程序）

API 端点

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

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

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

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

  
  

  

  
  

  Data Service 实体示例

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

  

  
  

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