Zendesk

借助 Zendesk 连接器，您可以对 Zendesk 数据库执行插入、删除、更新和读取操作。

支持的版本

此连接器支持 Zendesk 的 Version 2 API。

准备工作

在使用 Zendesk 连接器之前，请先完成以下任务：

在您的 Google Cloud 项目中：
- 将 roles/connectors.admin IAM 角色授予配置连接器的用户。
- 将以下 IAM 角色授予您要用其来使用连接器的服务账号：
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  服务账号是一种特殊类型的 Google 账号，用于表示需要验证身份并获得授权以访问 Google API 数据的非人类用户。如果您没有服务账号，则必须创建一个服务账号。如需了解详情，请参阅创建服务账号。
- 启用以下服务：
  - secretmanager.googleapis.com (Secret Manager API)
  - connectors.googleapis.com (Connectors API)
  如需了解如何启用服务，请参阅启用服务。
如果之前没有为您的项目启用这些服务或权限，则在您配置连接器时，系统会提示您启用。
如果您想使用电子邮件地址和密码访问 Zendesk API，请在 Zendesk 的管理员中心启用 password access。如需了解详情，请参阅基本身份验证。

配置连接器

配置连接器时，您需要创建与数据源（即后端系统）的连接。一个连接需专用于一个数据源。这意味着，如果您有许多数据源，则必须为每个数据源创建单独的连接。如需创建连接，请执行以下步骤：

在 Cloud 控制台中，进入 Integration Connectors > 连接页面，然后选择或创建一个 Google Cloud 项目。
转到“连接”页面
点击 + 新建以打开创建连接页面。
在位置部分中，选择连接的位置。
1. 区域：从下拉列表中选择一个位置。
  如需查看所有受支持区域的列表，请参阅位置。
2. 点击下一步。
在连接详情部分中，完成以下操作：
1. 连接器：从可用连接器的下拉列表中选择 Zendesk。
2. 连接器版本：从可用版本的下拉列表中选择一个连接器版本。
3. 在连接名称字段中，输入连接实例的名称。
  连接名称必须符合以下条件：
  - 连接名称可以使用字母、数字或连字符。
  - 字母必须小写。
  - 连接名称必须以字母开头，以字母或数字结尾。
  - 连接名称不能超过 63 个字符。
4. （可选）输入连接实例的说明。
5. 服务账号：选择具有所需角色的服务账号。
6. 如需将此连接用于事件订阅，请选择启用事件订阅。选择此选项，系统会显示以下选项：
  - 启用包含实体和操作的事件订阅：选择此选项可将连接用于事件订阅和连接器操作（实体和操作）。
  - 仅启用事件订阅：选择此选项可仅将连接用于事件订阅。
  对于这两种选择，系统都会在后续步骤中提示您配置事件详细信息。
7. （可选）配置连接节点设置：
  - 节点数下限：输入连接节点数下限。
  - 节点数上限：输入连接节点数上限。
  节点是处理事务的连接单元（或副本）。连接处理越多事务就需要越多节点，相反，处理越少事务需要越少节点。如需了解节点如何影响连接器价格，请参阅连接节点的价格。如果未输入任何值，则默认情况下，节点数下限设置为 2（以便提高可用性），节点数上限设置为 50。
8. 使用代理：选中此复选框可为连接配置代理服务器并配置以下值：
9. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
10. 点击下一步。
在目标部分中，输入要连接到的远程主机（后端系统）的详细信息。
1. Destination Type：选择 Destination Type。
  1. 在主机地址字段中，指定目标的主机名或 IP 地址。
    1. 如果要与后端系统建立专用连接，请按以下步骤操作：
      1. 创建 PSC 服务连接。
      2. 创建端点连接然后在主机地址字段中输入端点连接的详细信息。
    2. 如果要与后端系统建立公共连接以提高安全性，您可以考虑为连接配置静态出站 IP 地址，然后将防火墙规则配置为仅将特定静态 IP 地址列入许可名单。
  要输入其他目标，请点击 + 添加目标。
2. 点击下一步。
在身份验证部分中，输入身份验证详细信息。
1. 选择身份验证类型，然后输入相关详细信息。
  Zendesk 连接支持以下身份验证类型：
  - 用户名和密码
2. 点击下一步。
如果您启用了事件订阅，连接创建页面上会显示事件订阅详情部分。如需了解如何配置事件订阅详情，请参阅配置事件订阅。
查看：查看您的连接和身份验证详细信息。
点击创建。

配置身份验证

根据您要使用的身份验证输入详细信息。

用户名和密码
- 用户名：用于连接的 Zendesk 用户名。
- Password：包含与 Zendesk 用户名关联的密码的 Secret Manager Secret。

配置事件订阅

如果您启用了事件订阅，请在事件订阅详情部分中输入以下值：

选择目标类型。
- 主机地址：在 host 字段中输入后端系统的注册网址。
输入身份验证详细信息。
1. 用户名：输入用户名。
2. Password：选择包含与用户名关联的密码的 Secret Manager Secret。
3. 密钥版本：选择密钥版本。
（可选）如果您希望在后端系统的响应中附加其他信息，请选择启用数据丰富化。
其他信息特定于您为其配置了事件的实体。如需了解详情，请参阅事件通知中的数据丰富化。

注意：如果您仅为事件订阅配置了此连接，则无法启用此选项。如需启用数据丰富化，您必须为事件订阅和连接器操作（实体和操作）配置连接。
选择启用专用连接，以实现后端应用和连接之间的安全连接。如果您选择此选项，则必须在创建连接后执行其他配置步骤。如需了解详情，请参阅事件订阅的专用连接。
输入死信配置。如果您配置了死信，连接会将未处理的事件写入指定的 Pub/Sub 主题。输入以下详细信息：
1. 死信项目 ID ：您配置了死信 Pub/Sub 主题的 Google Cloud 项目的 ID。
2. 死信主题 ：您要在其中写入未处理事件详细信息的 Pub/Sub 主题。
如果您想使用代理来连接到后端（用于事件订阅），请输入以下详细信息：

代理 SSL 类型：连接到代理服务器时使用的 SSL 类型。选择以下任一身份验证类型：
- 始终：始终为事件订阅启用 SSL。
- 从不：未为事件订阅启用 SSL。
代理身份验证方案：选择要向代理服务器进行身份验证的身份验证类型。支持以下身份验证类型：
- 基本：基本 HTTP 身份验证。
代理用户：输入用于向代理服务器进行身份验证的用户名。
代理密码：选择用户密码的 Secret Manager 密钥。
密钥版本：选择密钥版本。
在代理服务器部分，输入代理服务器的详细信息。
1. 点击 + 添加目的地，然后选择目标类型作为主机地址。
2. 输入代理服务器的主机名或 IP 地址，以及代理服务器的端口号。

实体、操作和动作

所有集成连接器都会为所连接应用的对象提供抽象层。您只能通过此抽象访问应用的对象。抽象作为实体、操作和动作向您展示。

实体：实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如，在数据库连接器中，表是实体；在文件服务器连接器中，文件夹是实体；在消息传递系统连接器中，队列是实体。
不过，可能连接器不支持或不支持任何实体，在这种情况下，Entities 列表将为空。
操作：操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作：
- List（列出）
- 获取
- 创建
- 更新
- 删除
从可用列表中选择一个实体，系统会生成该实体可用的操作列表。如需了解操作的详细说明，请参阅连接器任务的实体操作。但是，如果连接器不支持任何实体操作，则此类不受支持的操作不会列在 Operations 列表中。
动作：动作是可通过连接器接口提供给集成的头等函数。动作可让您对一个或多个实体进行更改，并且动作因连接器而异。但可能的情况是，连接器不支持任何动作，在这种情况下，Actions 列表将为空。

系统限制

Zendesk 连接器每秒可以为每个节点处理 5 个事务，并限制任何超出此限制的事务。默认情况下，Integration Connectors 会为连接分配 2 个节点（以提高可用性）。

如需了解适用于 Integration Connectors 的限制，请参阅限制。

操作

Zendesk 连接器可根据 ticket ID 提供管理工单的操作。如需了解如何配置操作，请参阅操作示例。

操作示例

本部分介绍如何执行该连接器中的一些操作。

示例 - 删除工单

在 Configure connector task 对话框中，点击 Actions。
选择 DeleteTicketsPermanently 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
{
  "Id": "18"
}
```

此示例将永久删除车票。如果操作成功，连接器任务的 connectorOutputPayload 响应参数的值将如下所示：

[{
  "Success": "true"
}]

注意：DeleteTicketsPermanently 操作会永久删除一条记录。如果要执行软删除，请使用实体删除操作。

示例 - 合并票券

在 Configure connector task 对话框中，点击 Actions。
选择 MergeTickets 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
{
  "Id": "25",
  "Id": "26"
}
```

此示例合并了两张票券。如果操作成功，连接器任务的 connectorOutputPayload 响应参数的值将如下所示：

[{
  "Success": null,
  "Message": null
}]

示例 - 恢复工单

在 Configure connector task 对话框中，点击 Actions。
选择 RestoreTicket 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
{
  "id": "20"
}
```

此示例恢复了工单。如果操作成功，连接器任务的 connectorOutputPayload 响应参数的值将如下所示：

[{
  "Success": "true"
}]

示例 - 恢复已暂停的工单

在 Configure connector task 对话框中，点击 Actions。
选择 RecoverSuspendedTicket 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
{
  "id": "18726501985809"
}
```

以下示例恢复已暂停的工单。如果操作成功，连接器任务的 connectorOutputPayload 响应参数的值将如下所示：

[{
  "Id": "60921"
}]

实体操作示例

示例 - 列出所有门票

以下示例列出了 Tickets 实体中的所有票券。

在 Configure connector task 对话框中，点击 Entities。
从 Entity 列表中选择“票券”。
选择 LIST 操作，然后点击完成。

示例 - 获取门票

以下示例从 Tickets 实体获取 ID 为 35 的票据。

在 Configure connector task 对话框中，点击 Entities。
从 Entity 列表中选择 Tickets。
选择 GET 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 EntityId，然后在默认值字段中输入 35。
其中，35 是 Tickets 实体的主键值。

示例 - 创建工单

此示例在 Tickets 实体中创建一个工单。

在 Configure connector task 对话框中，点击 Entities。
从 Entity 列表中选择 Tickets。
选择 Create 操作，然后点击完成。

在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

{
    "Subject": "Zendesk_Create_Ticket",
    "Description": "Test",
    "Type": "incident",
    "Priority": "urgent",
    "Status": "open",
    "Recipient": null,
    "HasIncidents": false,
    "DueAt": null,
    "RequesterId": 3.84625885158E11,
    "SubmitterId": 3.84625883418E11,
    "AssigneeId": 3.84625883418E11,
    "OrganizationId": "16665992392721",
    "GroupId": 3.60008282358E11,
    "TicketFormId": 3.60001719218E11,
    "BrandId": 3.60003285058E11
  }

如果集成成功，连接器任务的 connectorOutputPayload 字段的值将如下所示：

 {
    "Id": 38.0
  }

示例 - 更新工单

此示例更新了 Tickets 实体中 ID 为 35 的票据。

在 Configure connector task 对话框中，点击 Entities。
从 Entity 列表中选择“票券”。
选择 Update 操作，然后点击完成。

在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

{
      "Subject": "Zendesk_Ticket_Update",
      "Description": "Updating the ticket",
      "RequesterId": 1.6854335860497E13
    }

点击 entityId，然后在 Default Value 字段中输入 35。
或者，您也可以不指定 entityId，而是将 filterClause 设置为 35。

如果集成成功，连接器任务的 connectorOutputPayload 字段的值将如下所示：
```
{
       Id": 35.0
    }
    
```

示例 - 删除工单

此示例将删除 Tickets 实体中 ID 为 35 的票券。

在 Configure connector task 对话框中，点击 Entities。
从 Entity 列表中选择“票券”。
选择 Delete 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 entityId，然后在默认值字段中输入 35。

注意：Delete 操作仅软删除记录。如果需要，您可以稍后恢复已删除的记录。

使用 Terraform 创建连接

您可以使用 Terraform 资源创建新连接。

如需了解如何应用或移除 Terraform 配置，请参阅基本 Terraform 命令。

如需查看用于创建连接的示例 Terraform 模板，请参阅示例模板。

使用 Terraform 创建此连接时，您必须在 Terraform 配置文件中设置以下变量：

参数名称	数据类型	需要	说明
proxy_enabled	BOOLEAN	False	选中此复选框可配置用于连接的代理服务器。
proxy_auth_scheme	ENUM	False	用于向 ProxyServer 代理进行身份验证的身份验证类型。支持的值包括：BASIC、DIGEST、NONE
proxy_user	STRING	False	用于向 ProxyServer 代理进行身份验证的用户名。
proxy_password	SECRET	False	用于对 ProxyServer 代理进行身份验证的密码。
proxy_ssltype	ENUM	False	连接到 ProxyServer 代理时使用的 SSL 类型。支持的值包括：AUTO、ALWAYS、NEVER、TUNNEL

在集成中使用 Zendesk 连接

创建连接后，它在 Apigee Integration 和 Application Integration 中均可使用。您可以通过连接器任务在集成中使用该连接。

如需了解如何在 Apigee Integration 中创建和使用连接器任务，请参阅连接器任务。
如需了解如何在 Application Integration 中创建和使用连接器任务，请参阅连接器任务。

向 Google Cloud 社区寻求帮助

您可以在 Cloud 论坛的 Google Cloud 社区发布您的问题并讨论此连接器。

后续步骤

了解如何暂停和恢复连接。
了解如何监控连接器的使用情况。
了解如何查看连接器日志。