本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# REST API 连接集成
<a name="rest-api-integration"></a>

借助 Amazon Quick 中的 REST API Connection 集成，您可以使用自定义 REST APIs 和网络服务执行操作。此集成仅支持操作执行。

## 您能做什么
<a name="rest-api-integration-capabilities"></a>

借助 REST API 连接集成，您可以通过操作连接器使用自定义 REST APIs 和 Web 服务执行操作。

**动作连接器**  
 APIs 使用灵活的身份验证选项执行 HTTP 请求、检索数据并与之交互。

**注意**  
REST API 连接集成不支持数据访问或知识库创建。它专为任务执行和与自定义 Web 服务的 API 交互而设计。

## 开始前的准备工作
<a name="rest-api-integration-prerequisites"></a>

在设置 REST API 集成之前，请确保具备以下条件：
+ 具有适当访问权限的 REST API 端点。
+ API 身份验证凭证（OAuth、API 密钥或其他）。
+ 目标 Web 服务的 API 文档。

## 准备 API 端点和身份验证
<a name="rest-api-integration-authentication"></a>

在 Amazon Quick 中配置集成之前，请准备好您的 REST API 终端节点和身份验证凭证。REST API 连接集成支持多种身份验证方法。选择符合您的 API 要求的方法：

**用户认证 (OAuth)**  
从您的 API 提供商那里收集以下信息：  
+ **基本网址**-REST API 基础网址。
+ **客户端 ID**- OAuth 应用程序客户端 ID。
+ **客户端密钥**- OAuth 应用程序客户端密钥。
+ **令牌网址**- OAuth 令牌端点。
+ **身份验证 URL**- OAuth 授权端点。
+ **重定向 URL**- OAuth 重定向 URI。

**服务认证 (Service-to-service OAuth)**  
从您的 API 提供商那里收集以下信息：  
+ **身份验证类型**- OAuth 2.0 客户端凭据授予 service-to-service身份验证流程。
+ **基本网址**-REST API 基础网址。
+ **客户端 ID**-用于服务身份验证的 OAuth 应用程序客户端标识符。
+ **客户端密钥**-用于服务身份验证的 OAuth 应用程序客户端密钥。
+ **令牌 URL**-用于获取访问 OAuth 令牌的令牌端点。

### 自定义标题和参数
<a name="rest-api-custom-headers"></a>

您可以使用自定义标头和参数进行灵活的身份验证和 API 交互：
+ 自定义身份验证标头。
+ API 版本标头。
+ 内容类型规范。
+ 自定义查询参数。

## 设置 REST API 集成
<a name="rest-api-integration-setup"></a>

准备好 API 端点和身份验证凭证后，请按照以下步骤创建 REST API 集成：

1. 在 Amazon Quick 控制台中，选择**集成。**

1. 从集成选项中选择 **REST API 连接**，然后单击 “添加”（加上 “\$1”）按钮。

1. 填写集成详情：
   + **名称**-您的 REST API 集成的描述性名称。
   + **描述**（可选）-集成的目的。

1. 选择您的连接类型：
   +  OAuth基于@@ **用户身份**验证的个人用户访问身份验证。
   + **服务身份验证**-基于API密钥的服务访问身份验证。

1. 根据您选择的身份验证方法（用户或服务）填写连接设置。

1. 选择**下一步**。

1. 查看可用的操作。

1. 选择**创建并继续**。

## 可用的任务操作
<a name="rest-api-integration-actions"></a>

创建 REST API 集成后，您可以查看用于与 REST API 交互的可用操作。常见的 REST API 操作包括：
+ HTTP 获取数据检索请求。
+ HTTP POST 请求创建数据。
+ HTTP PUT/PATCH 请求更新数据。
+ HTTP 删除请求删除数据。
+ 自定义端点交互。
+ JSON 和 XML 数据处理。
+ 查询参数和标头管理。

**注意**  
可用的具体操作取决于 REST API 端点和为集成配置的身份验证权限。

## API 配置选项
<a name="rest-api-integration-configuration"></a>

您可以配置 REST API 集成的各个方面，以满足您的特定要求。

### 端点配置
<a name="rest-api-endpoint-configuration"></a>

配置以下端点设置：
+ 基本 URL 和端点路径。
+ HTTP 方法规范。
+ 请求和响应格式处理。
+ 错误处理和重试逻辑。

### 数据处理
<a name="rest-api-data-handling"></a>

配置您的集成如何处理不同的数据格式：
+ JSON 请求和响应处理。
+ XML 数据转换。
+ 表单数据和分段上传。
+ 二进制数据处理。

## 管理 REST API 集成
<a name="rest-api-integration-management"></a>

创建 REST API 集成后，您可以使用以下选项对其进行管理：
+ **编辑集成**-更新身份验证设置、基本 URL 或 API 配置。
+ **共享集成**-使组织中的其他用户可以使用该集成。
+ **监控使用情况**-查看集成活动和 API 调用指标。
+ **查看操作**-查看可用 REST API 操作的完整列表。
+ **测试端点**-验证 API 连接和身份验证。
+ **删除集成**-移除集成并撤消关联的身份验证。

**重要**  
REST API 集成取决于目标 Web 服务的可用性和配置。API 或身份验证要求的更改可能会影响集成功能。