

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

# Connect 连接到第三方服务
<a name="add-connector-third-party"></a>

**Topics**
+ [

## OpenAPI 连接器与 API 连接器
](#add-connector-third-party-openapi-vs-api)
+ [

# Connect 连接到第三方服务和 APIs （通用）
](connectors-api.md)
+ [

# 使用 OpenAPI 连接到服务
](connectors-openapi.md)
+ [

# 连接 Salesforce
](connectors-salesforce.md)

## OpenAPI 连接器与 API 连接器
<a name="add-connector-third-party-openapi-vs-api"></a>

要从 App Studio 应用程序向第三方服务发送 API 请求，您必须创建和配置连接器，应用程序使用该连接器对服务进行身份验证并配置 API 调用。App Studio 提供了`API Connector`和`OpenAPI Connector`连接器类型来实现此目的，如下所述：
+ **API 连接器：**用于为任何类型的 REST API 配置身份验证和请求信息。
+ **OpenAPI 连接器：**用于配置已采用 OpenAPI 规范 (OAS) 的身份验证和请求信息。 APIs APIs 遵守美洲国家组织可以带来多项好处，包括标准化、安全、治理和文档。

App Studio 建议`OpenAPI Connector`对任何 APIs 符合 OAS 的用户使用，并提供 OpenAPI 规范文件。有关 OpenAPI 的更多信息，请参阅[什么是 Open](https://swagger.io/docs/specification/v3_0/about/) API？ 在 Swagger 文档中。

# Connect 连接到第三方服务和 APIs （通用）
<a name="connectors-api"></a>

使用以下步骤在 App Studio 中创建通用 **API 连接器**。**API 连接器**用于向 App Studio 应用程序提供对第三方服务、资源或操作的访问权限。

**使用 **API 连接器**连接到第三方服务**

1. 在左侧导航栏的**管理**区域，选择**连接器**。您将进入一个页面，其中显示了现有连接器的列表，其中包含每个连接器的一些详细信息。

1. 选择 **\$1 创建连接器**。

1. 选择 **API 连接器**。现在，通过填写以下字段来配置您的连接器。

1. **连接器名称：**为您的连接器提供一个名称。

1. **连接器描述：**为您的连接器提供描述。

1. **基本 URL：**第三方连接的网站或主机。例如 `www.slack.com`。

1. **身份验证方法：**选择使用目标服务进行身份验证的方法。
   + **无：**无需身份验证即可访问目标服务。
   + **基本：**使用从所连接的服务中获取的**用户名**和**密码**访问目标服务。
   + **不记名令牌：**使用从服务的用户账户或 API 设置中获取的身份验证令牌的令牌**值**访问目标服务。
   + **OAuth 2.0：**使用 OAuth 2.0 协议访问目标服务，该协议授予 App Studio 访问服务和资源的权限，而无需共享任何凭据或身份。要使用 OAuth 2.0 身份验证方法，必须先从所连接的服务中创建一个代表 App Studio 的应用程序，以获取必要的信息。使用这些信息，填写以下字段：

     1. **客户凭证流：**非常适合应用程序在没有用户 system-to-system交互的情况下代表自己操作的交互。例如，根据用户添加的新记录自动更新 Salesforce 记录的 CRM 应用程序，或者在报告中检索和显示交易数据的应用程序。

        1. 在 “**客户端 ID**” 中，输入从目标服务中创建的 OAuth 应用程序中获取的 ID。

        1. 在**客户端密钥**中，输入从目标服务中创建的 OAuth 应用程序中获取的密钥。

        1. 在**访问令牌 URL** 中，输入从目标服务中创建的 OAuth 应用程序中获取的令牌 URL。

        1. 或者，在**范围**中，输入应用程序的范围。范围是应用程序所需的权限或访问级别。请参阅目标服务的 API 文档以了解其范围，并仅配置您的 App Studio 应用程序所需的范围。

        选择 “**验证连接**” 以测试身份验证和连接。

     1. **授权码流：**非常适合需要代表用户执行操作的应用程序。例如，一个客户支持应用程序，用户可以在其中登录并查看和更新支持工单，或者一个销售应用程序，每个团队成员都可以在其中登录以查看和管理其销售数据。

        1. 在 “**客户端 ID**” 中，输入从目标服务中创建的 OAuth 应用程序中获取的 ID。

        1. 在**客户端密钥**中，输入从目标服务中创建的 OAuth 应用程序中获取的密钥。

        1. 在**授权 URL** 中，输入来自目标服务的授权 URL。

        1. 在**访问令牌 URL** 中，输入从目标服务中创建的 OAuth 应用程序中获取的令牌 URL。

        1. 或者，在**范围**中，输入应用程序的范围。范围是应用程序所需的权限或访问级别。请参阅目标服务的 API 文档以了解其范围，并仅配置您的 App Studio 应用程序所需的范围。

1. **标头：**添加用于提供有关请求或响应的元数据的 HTTP 标头。您可以同时添加键和值，也可以仅提供生成器可以在应用程序中为其提供值的密钥。

1. **查询参数：**添加用于将选项、过滤器或数据作为请求网址的一部分传递的查询参数。与标题类似，您可以同时提供键和值，也可以仅提供生成器可以在应用程序中为其提供值的密钥。

1. 选择**创建**。新创建的连接器将出现在**连接**器列表中。

现在，连接器已创建，构建者可以在他们的应用程序中使用它。

# 使用 OpenAPI 连接到服务
<a name="connectors-openapi"></a>

要使用 OpenAPI 将 App Studio 与服务连接起来，使构建者能够构建能够发送请求和接收来自服务的响应的应用程序，请执行以下步骤：

1. [获取 OpenAPI 规范文件并收集服务信息](#connectors-openapi-create-resources)

1. [创建 OpenAPI 连接器](#connectors-openapi-create-connector)

## 获取 OpenAPI 规范文件并收集服务信息
<a name="connectors-openapi-create-resources"></a>

要使用 OpenAPI 将服务连接到 App Studio，请执行以下步骤：

1. 转到你想要连接到 App Studio 的服务，然后找到 OpenAPI 规范 JSON 文件。
**注意**  
App Studio 支持符合 OpenAPI 规范版本 3.0.0 或更高版本的 OpenAPI 规范文件。

1. 收集配置 OpenAPI 连接器所需的数据，包括以下内容：
   + 用于连接到服务的基本 URL。
   + 身份验证凭证，例如令牌或用户名/密码。
   + 任何标题（如果适用）。
   + 任何查询参数（如果适用）。

## 创建 OpenAPI 连接器
<a name="connectors-openapi-create-connector"></a>

**为 OpenAPI 创建连接器**

1. 导航到 App Studio。

1. 在左侧导航栏的**管理**区域，选择**连接器**。您将进入一个页面，其中显示了现有连接器的列表，其中包含每个连接器的一些详细信息。

1. 选择 **\$1 创建连接器**。

1. 从**连接器类型列表中选择 OpenAPI** 连接器。现在，通过填写以下字段来配置您的连接器。

1. **名称：**输入 OpenAPI 连接器的名称。

1. **描述：**输入您的 OpenAPI 连接器的描述。

1. **基本 URL：**输入用于连接到服务的基本 URL。

1. **身份验证方法：**选择使用目标服务进行身份验证的方法。
   + **无：**无需身份验证即可访问目标服务。
   + **基本：**使用从所连接的服务中获取的**用户名**和**密码**访问目标服务。
   + **不记名令牌：**使用从服务的用户账户或 API 设置中获取的身份验证令牌的令牌**值**访问目标服务。
   + **OAuth 2.0：**使用 OAuth 2.0 协议访问目标服务，该协议授予 App Studio 访问服务和资源的权限，而无需共享任何凭据或身份。要使用 OAuth 2.0 身份验证方法，必须先从所连接的服务中创建一个代表 App Studio 的应用程序，以获取必要的信息。使用这些信息，填写以下字段：

     1. **客户凭证流程：**

        1. 在**客户端 ID** 中，输入目标服务的 ID。

        1. 在**客户端密钥**中，输入来自目标服务的密钥。

        1. 在**访问令牌 URL** 中，输入来自目标服务的令牌 URL。

        1. 或者，在**范围**中，输入应用程序的范围。范围是应用程序所需的权限或访问级别。请参阅目标服务的 API 文档以了解其范围，并仅配置您的 App Studio 应用程序所需的范围。

        在每次调用时添加要随服务发送的所有**变量**，然后选择**验证连接**以测试身份验证和连接。

     1. **授权码流程：**

        1. 在**客户端 ID** 中，输入目标服务的 ID。

        1. 在**客户端密钥**中，输入来自目标服务的密钥。

        1. 在**授权 URL** 中，输入来自目标服务的授权 URL。

        1. 在**访问令牌 URL** 中，输入来自目标服务的令牌 URL。

        1. 或者，在**范围**中，输入应用程序的范围。范围是应用程序所需的权限或访问级别。请参阅目标服务的 API 文档以了解其范围，并仅配置您的 App Studio 应用程序所需的范围。

1. **变量：**添加每次调用时要发送到服务的变量。配置期间添加的变量会被安全存储，并且只有在使用连接的应用程序的运行时才能访问。

1. **标头：**添加用于提供有关请求或响应的元数据的 HTTP 标头。您可以同时添加键和值，也可以仅提供生成器可以在应用程序中为其提供值的密钥。

1. **查询参数：**添加用于将选项、过滤器或数据作为请求网址的一部分传递的查询参数。与标题类似，您可以同时提供键和值，也可以仅提供生成器可以在应用程序中为其提供值的密钥。

1. **OpenAPI 规范文件：**通过拖放来上传 OpenAPI 规范 JSON 文件，或者**选择选择文件**来浏览本地文件系统并选择要上传的文件。

   添加后，文件即被处理并显示可用选项列表。为您的连接器选择必要的操作。

1. 选择**创建**。新创建的连接器将出现在**连接**器列表中。

现在，连接器已创建，构建者可以在他们的应用程序中使用它。

# 连接 Salesforce
<a name="connectors-salesforce"></a>

要将 App Studio 与 Salesforce 连接以使构建者能够在应用程序中访问和使用 Salesforce 资源，您必须在 Salesforce 中创建和配置连接的应用程序，并在 App Studio 中创建 Salesforce 连接器。

**将 Salesforce 与 App Stud**

1. 在 App Studio 的导航窗格中，选择**管理**部分的**连接器**。您将进入一个页面，其中显示了现有连接器的列表，其中包含每个连接器的一些详细信息。

1. 选择 **\$1 创建连接器**。

1. 从连接器类型列表中选择 **Salesforce** 以打开连接器创建页面。

1. 记下**重定向网址**，您将在以下步骤中使用该网址来配置 Salesforce。

1. 下一步是在 Salesforce 中创建一个联网应用程序。在另一个选项卡或窗口中，导航到您的 Salesforce 实例。

1. 在 “快速查找” 框中，搜索，**App Manager**然后选择 “**应用程序管理器**”。

1. 选择 “**新建连接的应用程序**”。

1. 在**已连接的应用程序名称**和 **API 名称**中，输入您的应用程序的名称。它不必与你的 App Studio 应用程序名称相匹配。

1. 根据需要提供联系信息。

1. 在 **API（启用 OAuth 设置）**部分，启用**启用 OAuth 设置**。

1. 在**回调网址**中，输入你之前在 App Studio 中记下的**重定向网址**。

1. 在**选定 OAuth 范围**中，从列表中添加必要的权限范围。App Studio 可以与 Salesforce REST APIs 交互，对五个对象执行 CRUD 操作：客户、案例、联系人、潜在客户和机会。建议添加**完全访问权限（完整）**，以确保您的 App Studio 应用程序具有所有相关的权限或范围。

1. 禁用 “**支持的授权流需要验证密钥进行代码交换 (PKCE) 扩展**” 选项。App Studio 不支持 PKCE。

1. 启**用 Web 服务器流****需要密钥和刷新令牌流**需要密钥以遵循最佳安全实践。

1. App Studio 支持以下两个身份验证流程：
   + **客户凭证流程**：非常适合应用程序在没有用户 server-to-server交互的情况下代表自己操作的交互。例如，列出没有 Salesforce 访问权限的临时员工团队的所有潜在客户信息。
   + **授权码流程**：适用于代表用户行事的应用程序，例如个人数据访问或操作。例如，列出每位销售经理获取或拥有的潜在客户，以便通过此应用程序执行其他任务。
   + 对于客户凭证流程：

     1. 启用 **“启用客户机凭证流**”。查看并确认消息。

     1. 保存应用程序。

     1. 尽管流程中没有用户交互，但您必须选择执行用户。通过选择执行用户，Salesforce 代表该用户返回访问令牌。

        1. 在**应用程序管理器**中，从应用程序列表中选择 App Studio 应用程序的箭头，然后选择**管理**。

        1. 选择 “**编辑策略”**

        1. 在 “**客户凭证流**” 中，添加相应的用户。
   + 对于授权码流程，启用**启用授权码和凭证流程**

1. Salesforce 提供了客户端 ID 和客户端密钥，在以下步骤中，必须使用它们在 App Studio 中配置连接器。

   1. 在**应用程序管理器**中，选择 App Studio 应用程序的箭头，然后选择**查看**。

   1. 在 **API（启用 OAuth 设置）**部分中，选择**管理消费者详细信息**。这可能会发送一封电子邮件以获取验证密钥，您需要输入验证密钥进行确认。

   1. 记下**消费者密钥**（客户端 ID）和**消费者密钥**（客户机密）。

1. 返回 App Studio，通过填写以下字段来配置和创建您的连接器。

1. 在**名称**中，输入您的 Salesforce 连接器的名称。

1. 在**描述**中，输入您的 Salesforce 连接器的描述。

1. 在**基本网址**中，输入您的 Salesforce 实例的基本网址。它应该看起来像这样:`https://hostname.salesforce.com/services/data/v60.0`，替换*hostname*为你的 Salesforce 实例名称。

1. 在 “**身份验证方法**” 中，确保选择 **OAuth 2.0**。

1. 在 **OAuth 2.0 Flow** 中，选择 OAuth 身份验证方法并填写相关字段：
   + 选择 “**客户凭证流**”，以便在代表自己行事的应用程序中使用以进行 system-to-system集成。

     1. 在 “**客户端 ID**” 中，输入之前从 Salesforce 获得的使用**者密钥**。

     1. 在**客户密钥**中，输入之前从 Salesforce 获得的**消费者机密**。

     1. 在**访问令牌 URL** 中，输入 OAuth 2.0 令牌端点。它应该看起来像这样:`https://hostname/services/oauth2/token`，替换*hostname*为你的 Salesforce 实例名称。有关更多信息，请参阅 [Salesforce OAuth 终端节点](https://help.salesforce.com/s/articleView?id=sf.remoteaccess_oauth_endpoints.htm&type=5)文档。

     1. 选择 “**验证连接**” 以测试身份验证和连接。
   + 选择 “**授权代码流**”，以便在代表用户执行操作的应用程序中使用。

     1. 在 “**客户端 ID**” 中，输入之前从 Salesforce 获得的使用**者密钥**。

     1. 在**客户密钥**中，输入之前从 Salesforce 获得的**消费者机密**。

     1. 在**授权 URL** 中，输入授权端点。它应该看起来像这样:`https://hostname/services/oauth2/authorize`，替换*hostname*为你的 Salesforce 实例名称。有关更多信息，请参阅 [Salesforce OAuth 终端节点](https://help.salesforce.com/s/articleView?id=sf.remoteaccess_oauth_endpoints.htm&type=5)文档。

     1. 在**访问令牌 URL** 中，输入 OAuth 2.0 令牌端点。它应该看起来像这样:`https://hostname/services/oauth2/token`，替换*hostname*为你的 Salesforce 实例名称。有关更多信息，请参阅 [Salesforce OAuth 终端节点](https://help.salesforce.com/s/articleView?id=sf.remoteaccess_oauth_endpoints.htm&type=5)文档。

1. 在**操作**中，选择您的连接器将支持的 Salesforce 操作。此列表中的操作是预定义的，代表 Salesforce 中的常见任务，例如创建、检索、更新或删除常用对象中的记录。

1. 选择**创建**。新创建的连接器将出现在**连接**器列表中。