Zendesk
借助 Zendesk 连接器,您可以对 Zendesk 数据库执行插入、删除、更新和读取操作。
支持的版本
该连接器支持 Zendesk 的第 2 版 API。
准备工作
在使用 Zendesk 连接器之前,请先完成以下任务:
- 在您的 Google Cloud 项目中:
- 将 IAM 角色 roles/connectors.admin 授予配置连接器的用户。
- 将以下 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 项目。
- 点击 + 新建以打开创建连接页面。
- 在位置部分中,选择连接的位置。
- 区域:从下拉列表中选择一个位置。
如需查看所有受支持区域的列表,请参阅位置。
- 点击下一步。
- 区域:从下拉列表中选择一个位置。
- 在连接详情部分中,完成以下操作:
- 连接器:从可用连接器的下拉列表中选择 Zendesk。
- 连接器版本:从可用版本的下拉列表中选择一个连接器版本。
- 在连接名称字段中,输入连接实例的名称。
连接名称必须符合以下条件:
- 连接名称可以使用字母、数字或连字符。
- 字母必须小写。
- 连接名称必须以字母开头,以字母或数字结尾。
- 连接名称不能超过 63 个字符。
- (可选)输入连接实例的说明。
- 服务账号:选择具有所需角色的服务账号。
- 如需将连接用于事件订阅,请选择启用事件订阅。选择此选项,系统会显示以下选项:
- 为事件订阅启用实体和操作:选择此选项可将连接同时用于事件订阅和连接器操作(实体和操作)。
- Enable only event subscription(仅启用事件订阅):选择此选项可将连接仅用于事件订阅。如果您选择此选项,请点击下一步,然后配置事件订阅。
- (可选)配置连接节点设置:
- 节点数下限:输入连接节点数下限。
- 节点数上限:输入连接节点数上限。
节点是处理事务的连接单元(或副本)。 连接处理越多事务就需要越多节点,相反,处理越少事务需要越少节点。 如需了解节点如何影响连接器价格,请参阅连接节点的价格。如果未输入任何值,则默认情况下,节点数下限设置为 2(以便提高可用性),节点数上限设置为 50。
- 使用代理:选中此复选框可为连接配置代理服务器并配置以下值:
-
代理身份验证方案:选择要通过代理服务器进行身份验证的身份验证类型。支持以下身份验证类型:
- 基本:基本 HTTP 身份验证。
- 摘要:摘要 HTTP 身份验证。
- 代理用户:用于向代理服务器进行身份验证的用户名。
- 代理密码:用户密码的 Secret Manager 密文。
-
代理 SSL 类型:连接到代理服务器时使用的 SSL 类型。支持以下身份验证类型:
- 自动:默认设置。如果网址是 HTTPS 网址,则使用“隧道”选项。如果网址是 HTTP 网址,则使用“永不”选项。
- 始终:连接始终启用 SSL。
- 永不:连接未启用 SSL。
- 隧道:连接通过隧道代理建立。代理服务器会打开与远程主机的连接,并且流量会流经该代理。
- 在代理服务器部分中,输入代理服务器的详细信息。
- (可选)点击 + 添加标签,以键值对的形式向连接添加标签。
- 点击下一步。
- 在目标部分中,输入要连接到的远程主机(后端系统)的详细信息。
- 目的地类型:选择目的地类型。
- 从列表中选择主机地址,以指定目的地的主机名或 IP 地址。
- 如果要与后端系统建立专用连接,请从列表中选择端点连接,然后从端点连接列表中选择所需的端点连接。
如果要与后端系统建立公共连接以提高安全性,您可以考虑为连接配置静态出站 IP 地址,然后将防火墙规则配置为仅将特定静态 IP 地址列入许可名单。
要输入其他目标,请点击 + 添加目标。
- 点击下一步。
- 目的地类型:选择目的地类型。
-
在 Authentication(身份验证)部分中,输入身份验证详细信息。
- 选择身份验证类型,然后输入相关详细信息。
Zendesk 连接支持以下身份验证类型:
- 用户名和密码
- 点击下一步。
如需了解如何配置这些身份验证类型,请参阅配置身份验证。
- 选择身份验证类型,然后输入相关详细信息。
- 如果您已启用事件订阅,则连接创建页面上会显示事件订阅详情部分。如需了解如何配置事件订阅详细信息,请参阅配置事件订阅。
- 查看:查看您的连接和身份验证详细信息。
- 点击创建。
配置身份验证
根据您要使用的身份验证输入详细信息。
-
用户名和密码
- 用户名:用于连接的 Zendesk 用户名。
- Password:包含与 Zendesk 用户名关联的密码的 Secret Manager 密钥。
配置事件订阅
如果您启用了事件订阅,请在 Event Subscription Details 部分中输入以下值:
- 选择目的地类型。
- 主机地址:在 host 字段中输入后端系统的注册网址。
- 输入身份验证详细信息。
- 用户名:输入用户名。
- Password:选择包含与用户名关联的密码的 Secret Manager 密钥。
- 密钥版本:选择密钥版本。
- (可选)如果您希望将其他信息附加到后端系统的响应中,请选择启用数据丰富功能。
额外信息仅适用于您为其配置事件的实体。如需了解详情,请参阅事件通知中的数据丰富。
- 选择启用专用连接,以在后端应用与您的连接之间实现安全连接。如果您选择此选项,则必须在创建连接后执行额外的配置步骤。如需了解详情,请参阅适用于事件订阅的专用连接。
- 输入死信配置。如果您配置死信,连接会将未处理的事件写入指定的 Pub/Sub 主题。输入以下详细信息:
- 死信项目 ID :您在其中配置了死信 Pub/Sub 主题的 Google Cloud 项目的 ID。
- 死信主题 :您要在其中写入未处理事件详细信息的 Pub/Sub 主题。
- 如果您想使用代理连接到后端(用于事件订阅),请输入以下详细信息:
- 代理 SSL 类型:连接到代理服务器时使用的 SSL 类型。选择以下任意身份验证类型:
- 始终:连接始终为事件订阅启用 SSL。
- 从不:表示事件订阅未启用 SSL 连接。
- 代理身份验证方案:选择用于向代理服务器进行身份验证的身份验证类型。
支持以下身份验证类型:
- 基本:基本 HTTP 身份验证。
- 代理用户:输入用于通过代理服务器进行身份验证的用户名。
- 代理密码:选择用户密码的 Secret Manager 密钥。
- 密钥版本:选择密钥版本。
- 在代理服务器部分,输入代理服务器的详细信息。
- 点击 + 添加目的地,然后选择目的地类型作为主机地址。
- 输入代理服务器的主机名或 IP 地址,以及代理服务器的端口号。
实体、操作和动作
所有集成连接器都会为所连接应用的对象提供抽象层。您只能通过此抽象访问应用的对象。抽象作为实体、操作和动作向您展示。
- 实体:实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如,在数据库连接器中,表是实体;在文件服务器连接器中,文件夹是实体;在消息传递系统连接器中,队列是实体。
但是,连接器可能不支持或不支持任何实体,在这种情况下,
Entities
列表将为空。 - 操作:操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作:
从可用列表中选择一个实体,系统会生成该实体可用的操作列表。如需了解操作的详细说明,请参阅连接器任务的实体操作。但是,如果连接器不支持任何实体操作,则
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" }]
示例 - 合并门票
- 在
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
列表中选择 Tickets。 - 选择
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
列表中选择 Tickets。 - 选择
Update
操作,然后点击完成。 - 在连接器任务的任务输入部分中,点击
connectorInputPayload
,然后在Default Value
字段中输入类似于以下内容的值:{ "Subject": "Zendesk_Ticket_Update", "Description": "Updating the ticket", "RequesterId": 1.6854335860497E13 }
- 点击 entityId,然后在 Default Value 字段中输入
35
。或者,您也可以将 filterClause 设置为
35
,而不是指定 entityId。如果集成成功,则连接器任务的
connectorOutputPayload
字段的值将类似于以下内容:{ Id": 35.0 }
示例 - 删除工单
以下示例将删除 Tickets
实体中 ID 为 35 的票券。
- 在
Configure connector task
对话框中,点击Entities
。 - 从
Entity
列表中选择 Tickets。 - 选择
Delete
操作,然后点击完成。 - 在连接器任务的任务输入部分中,点击 entityId,然后在默认值字段中输入
35
。
使用 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 中都可用。您可以通过连接器任务在集成中使用该连接。