Zendesk

配置身份验证

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

• 用户名和密码（已弃用）
  • 用户名：用于连接的 Zendesk 用户名。
  • 密码：包含与 Zendesk 用户名关联的密码的 Secret Manager Secret。
• API 令牌
  • 用户：用于进行身份验证的 Zendesk 用户账号。
  • API 令牌：经过身份验证的用户的 API 令牌。
  • 密钥版本：相应密钥的密钥版本。
• OAuth 2.0 - 授权代码
  • 客户端 ID：连接器为您创建的应用提供的客户端 ID。
  • 范围：所需的逗号分隔列表。
  • 客户端密钥：包含您创建的关联应用的客户端密钥的 Secret Manager 密文。
  • 密钥版本：相应密钥的密钥版本。
  • 授权网址：在 Zendesk 实例中创建客户端时生成的授权网址。

配置事件订阅

如果您已启用事件订阅，请在事件订阅详细信息部分中输入以下值：

1. 选择目标类型。
   • 主机地址：在主机字段中输入后端系统的注册网址。
2. 选择 API 令牌作为身份验证类型。请勿选择用户名和密码。
3. 输入身份验证详细信息。
   1. 用户：用于进行身份验证的 Zendesk 用户账号。
   2. API 令牌：经过身份验证的用户的 API 令牌。
   3. 密钥版本：相应密钥的密钥版本。
4. （可选）如果您希望在后端系统的响应中附加其他信息，请选择启用数据丰富化。

   其他信息特定于您为其配置事件的实体。如需了解详情，请参阅事件通知中的数据丰富。

5. 选择启用专用连接，以在后端应用与连接之间建立安全连接。如果您选择此选项，则必须在创建连接后执行额外的配置步骤。如需了解详情，请参阅事件订阅的专用连接。
6. 输入死信配置。如果您配置了死信，连接会将未处理的事件写入指定的 Pub/Sub 主题。输入以下详细信息：
   1. 死信项目 ID： 您已配置死信 Pub/Sub 主题的 Google Cloud 项目 ID。
   2. 死信主题： 您要将未处理事件的详细信息写入到的 Pub/Sub 主题。
7. 如果您想使用代理连接到后端（用于订阅活动），请输入以下详细信息：
1. 代理 SSL 类型：连接到代理服务器时使用的 SSL 类型。选择以下任一身份验证类型：
   • 始终：连接始终启用 SSL 以进行事件订阅。
   • 永不：连接未针对事件订阅启用 SSL。
2. 代理身份验证方案：选择要通过代理服务器进行身份验证的身份验证类型。 支持以下身份验证类型：
   • 基本：基本 HTTP 身份验证。
3. 代理用户：输入用于向代理服务器进行身份验证的用户名。
4. 代理密码：选择用户密码的 Secret Manager 密文。
5. 密文版本：选择密文版本。
6. 在代理服务器部分中，输入代理服务器的详细信息。
   1. 点击 + 添加目标，然后选择目标类型作为主机地址。
   2. 输入代理服务器的主机名或 IP 地址，以及代理服务器的端口号。

连接配置示例

基本身份验证连接类型（已弃用）

API 令牌连接类型

OAuth 2.0 - 授权代码连接类型

与 Zendesk 的连接默认使用 SSL，如果您使用的是标准 Zendesk 网址（例如 https://yoursubdomain.zendesk.com），则无需进行额外配置。

实体、操作和动作

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

• 实体：实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如，在数据库连接器中，表是实体；在文件服务器连接器中，文件夹是实体；在消息传递系统连接器中，队列是实体。

  但可能的情况是，连接器不支持或不具有任何实体，在这种情况下，Entities 列表将为空。

• 操作：操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作：
  • 列表
  • 获取
  • 创建
  • 更新
  • 删除

  从可用列表中选择一个实体，系统会生成该实体可用的操作列表。如需了解操作的详细说明，请参阅连接器任务的实体操作。不过，如果连接器不支持任何实体操作，则不支持的操作不会列在 Operations 列表中。

• 动作：动作是可通过连接器接口提供给集成的头等函数。动作可让您对一个或多个实体进行更改，并且动作因连接器而异。通常，操作会包含一些输入参数和一个输出参数。但可能的情况是，连接器不支持任何动作，在这种情况下，Actions 列表将为空。

系统限制

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

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

操作

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

操作示例

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

示例 - 删除车票

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

   {
     "Id": "18"
   }

此示例会永久删除工单。如果操作成功，连接器任务的 connectorOutputPayload 响应参数将具有类似以下的值：

[{
  "Success": "true"
}] 

示例 - 合并工单

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 MergeTickets 操作，然后点击完成。
3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
     "Id": "25",
     "Id": "26"
   }

此示例将这两个工单合并。如果操作成功，连接器任务的 connectorOutputPayload 响应参数将具有类似以下的值：

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

示例 - 恢复工单

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

   {
     "id": "20"
   }

此示例会恢复工单。如果操作成功，连接器任务的 connectorOutputPayload 响应参数将具有类似以下的值：

[{
  "Success": "true"
}] 

示例 - 恢复已暂停的支持请求

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

   {
     "id": "18726501985809"
   }

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

[{
  "Id": "60921"
}]

实体操作示例

示例 - 对工单执行的列表操作

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

您可以对以下实体执行 List 操作：

附件、工单评论、工单表单、工单字段、请求、工单审核、工单指标、暂停的工单、共享协议、用户、UserIdentities、UserRelatedInformation、UserFields、OrganizationFields 和 JobStatus

示例 - 对 Tickets 执行的 Get 操作

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Tickets。
3. 选择 Get 操作，然后点击完成。
4. 在此示例中，entityId 设置为 34.0。如需设置 entityId，请在连接器任务的任务输入部分，点击 entityId，然后在 Default Value 字段中输入 34.0。

您可以对以下实体执行 Get 操作：

工单表单、工单字段、请求、工单审核、已暂停的工单、用户字段、UserIdentities 和用户

示例 - 对工单执行创建操作

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Tickets。
3. 选择 Create 操作，然后点击完成。
4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
       "Subject": "Zendesk_Create_Ticket",
       "RawSubject": "Zendesk_Create",
       "Description": "this ticket is related to application integration Create operation",
       "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,
       "Tags": null,
       "ViaChannel": "web",
       "ViaSource": "{\r\n  \"from\": null,\r\n  \"to\": null,\r\n  \"rel\": null\r\n}",
       "CustomFields": null,
       "SatisfactionRating": null,
       "SharingAgreementIds": null,
       "AllowChannelback": false,
       "IsPublic": true,
       "Url": "https://altostrat.zendesk.com/api/v2/tickets/1.json"
     }
     

   如果集成成功，连接器任务的 connectorOutputPayload 字段将具有类似以下的值：

    {
       "Id": 38.0
     }
     

示例 - 对 TicketForms 执行创建操作

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 TicketForms。
3. 选择 Create 操作，然后点击完成。
4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
       "Name": "Altostrat_Zendesk1",
       "RawName": "Altostrat_Zendesk1",
       "DisplayName": "Altostrat_Issues1",
       "RawDisplayName": "Altostrat_Issues1",
       "Position": 2.0,
       "Active": true,
       "EndUserVisible": true,
       "Default": false,
       "InAllBrands": true,
       "RestrictedBrandIds": null,
       "FallbackToDefault": null,
       "AssociatedToBrand": null
     }
     

   如果集成成功，TicketForms 任务的 connectorOutputPayload 响应参数将具有类似于以下的值：

   {
       "Id":1.8104712053393E13
     }
     

示例 - 对 TicketFields 执行创建操作

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 TicketFields。
3. 选择 Create 操作，然后点击完成。
4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
       "Type": "text",
       "Title": "New field created",
       "RawTitle": null,
       "Description": "Please create the new field",
       "RawDescription": null,
       "Position": 2.0,
       "Active": true,
       "Required": false,
       "CollapsedForAgents": false,
       "RegexpForValidation": null,
       "VisibleInPortal": true,
       "EditableInPortal": true,
       "Tag": null,
       "CreatedAt": "2021-07-06 06:35:19.0",
       "UpdatedAt": "2021-07-06 06:35:19.0",
       "SystemFieldOptions": null,
       "CustomFieldOptions": null,
       "Removable": false
     }
     

   如果集成成功，TicketFields 任务的 connectorOutputPayload 响应参数将具有类似于以下的值：

   {
       "Id": 1.7139061374865E13
     }
     

示例 - 对 SharingAgreements 执行创建操作

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 SharingAgreements。
3. 选择 Create 操作，然后点击完成。
4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
       "Name": "altostrat.zendesk.com",
       "RemoteSubdomain": "altostrat"
     }
     

   如果集成成功，SharingAgreements 任务的 connectorOutputPayload 响应参数将具有类似于以下的值：

   {
       "Id": 1.7142672288273E13
     }
     

示例 - 对用户执行创建操作

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Users。
3. 选择 Create 操作，然后点击完成。
4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
       "Email": "cloudysanfrancisco@gmail.com",
       "Name": "Altostrat Team"
     }
     

   如果集成成功，Users 任务的 connectorOutputPayload 响应参数将具有类似于以下的值：

   {
       "Id": 1.7156912480273E13
     }
     

示例 - 对 UserIdentities 执行创建操作

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 UserIdentities。
3. 选择 Create 操作，然后点击完成。
4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
       "UserId": 3.84637722338E11,
       "Type": "email",
       "Value": "cloudysanfrancisco@gmail.com",
       "Verified": false,
       "Primary": true,
       "DeliverableState": "reserved_example",
       "Url": "https://d3valtostrat1625553311.zendesk.com/api/v2/users/384637722338/identities/368240277818.json"
     }
     

   如果集成成功，UserIdentities 任务的 connectorOutputPayload 响应参数将具有类似于以下的值：

   {
       "Id": 1.6961185982353E13
     } 
     

示例 - 对 UserFields 执行创建操作

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 UserFields。
3. 选择 Create 操作，然后点击完成。
4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
       "Title": "Support description",
       "Type": "text",
       "Key": "support_description"
     }
     

   如果集成成功，UserFields 任务的 connectorOutputPayload 响应参数将具有类似于以下的值：

   {
       "Id": 1.7157236761873E13
     }
     

示例 - 对工单执行更新操作

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Tickets。
3. 选择 Update 操作，然后点击完成。
4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
       "Subject": "Google_Altostrat_Zendesk Update",
       "RawSubject": "Google_Altostrat_Zendesk Update",
       "Description": "this ticket is related to googlecloud application integration update check",
       "RequesterId": 1.6854335860497E13
     }
     

5. 在此示例中，entityId 设置为 35.0。如需设置 entityId，请点击 entityId，然后在默认值字段中输入 35。

   您也可以将 filterClause 设置为 35，而不是指定 entityId。

   如果集成成功，连接器任务的 connectorOutputPayload 字段将具有类似以下的值：

   {
         Id": 35.0
     }
     

示例 - 对 TicketForms 执行更新操作

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 TicketForms。
3. 选择 Update 操作，然后点击完成。
4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
       "Name": "Ticketforms Updated",
       "DisplayName": "Altostrat_Issues1",
       "RawDisplayName": "Altostrat_Issues1"
     }
     

5. 在此示例中，entityId 设置为 1.7137314972689E13。如需设置 entityId，请点击 entityId，然后在默认值字段中输入 1.7137314972689E13。

   您也可以将 filterClause 设置为 1.7137314972689E13，而不是指定 entityId。

   运行此示例后，连接器任务的 connectorOutputPayload 输出变量中会返回类似于以下内容的响应：

   {
         Id": 1.7137314972689E13
     }
     

示例 - 对 TicketFields 执行更新操作

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 TicketFields。
3. 选择 Update 操作，然后点击完成。
4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
       "Description": "Updated description for testing"
     }
     

5. 在此示例中，entityId 设置为 3.60022990118E11。如需设置 entityId，请点击 entityId，然后在默认值字段中输入 3.60022990118E11。

   您也可以将 filterClause 设置为 3.60022990118E11，而不是指定 entityId。

   运行此示例后，连接器任务的 connectorOutputPayload 输出变量中会返回类似于以下内容的响应：

   {
         Id": 3.60022990118E11
     }
     

示例 - 对用户的更新操作

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Users。
3. 选择 Update 操作，然后点击完成。
4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
       "Name": "The Customer update",
       "Last Name": "Alex",
       "First Name": "Charlie"
     }
     

5. 在此示例中，entityId 设置为 3.84625885158E11。如需设置 entityId，请点击 entityId，然后在默认值字段中输入 3.84625885158E11。

   您也可以将 filterClause 设置为 3.84625885158E11，而不是指定 entityId。

   运行此示例后，连接器任务的 connectorOutputPayload 输出变量中会返回类似于以下内容的响应：

   {
         Id": 3.84625885158E11
     }
     

示例 - 对 UserFields 执行更新操作

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 UserFields。
3. 选择 Update 操作，然后点击完成。
4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
       "Title": "Support description updated",
       "Type": "text",
       "Key": "support_description"
     }
     

5. 在此示例中，entityId 设置为 1.7157236761873E13。如需设置 entityId，请点击 entityId，然后在默认值字段中输入 1.7157236761873E13。

   您也可以将 filterClause 设置为 1.7157236761873E13，而不是指定 entityId。

   运行此示例后，连接器任务的 connectorOutputPayload 输出变量中会返回类似于以下内容的响应：

   {
         Id": 1.7157236761873E13
     }
     

示例 - 对 UserIdentities 的更新操作

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 UserIdentities。
3. 选择 Update 操作，然后点击完成。
4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
       "Verified": true
     }
     

5. 在此实体中，可以使用过滤子句和复合主键来执行更新操作，因此不需要 entityId。

您也可以将 filterClause 设置为 UserId='384625885158' and Id='368234205078'，而不是指定 entityId。

运行此示例后，连接器任务的 connectorOutputPayload 输出变量中会返回类似于以下内容的响应：

{
    "Id": 3.68234205078E11
  }
  

示例 - 对工单执行删除操作

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Tickets。
3. 选择 Delete 操作，然后点击完成。
4. 在此示例中，entityId 设置为 35.0。如需设置 entityId，请在连接器任务的任务输入部分，点击 entityId，然后在默认值字段中输入 35。

您可以对以下实体执行删除操作：

工单字段、已暂停的工单、UserIdentities、用户字段和用户

在集成中使用 Zendesk 连接

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

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