GetZendesk

文档中心 › 组件索引 › GetZendesk

GetZendesk Processor

类型全限定名：cn.org.acal.lynxus.processors.zendesk.GetZendesk

所属 Bundle：cn.org.acal.lynxus:lynxus-zendesk-nar:2.11.8

描述

从 Zendesk API 增量获取数据。

标签

zendesk

属性

下表中，加粗的属性为必填项；其余为可选项。表格同时标注默认值、是否支持表达式语言，以及是否为敏感属性（值会被加密）。

名称默认值可选值描述
Web Client Service Provider控制器服务 API：
WebClientServiceProvider
cn.org.acal.lynxus-lynxus-standard-services-api-nar-2.11.8		用于 HTTP 客户端操作的Controller Service。
Subdomain NameZendesk 子域的名称。
支持表达式语言：是（使用 FlowFile 属性与环境/系统变量求值）
User Name将用户登录到 Zendesk 子域。
支持表达式语言：是（使用 FlowFile 属性与环境/系统变量求值）
Authentication Type
  • Password — Zendesk 登录用户的密码。
  • Token — 在 Zendesk Admin 菜单中生成的用于 API 访问的身份验证令牌。
Zendesk API 的身份验证类型。
Authentication CredentialZendesk 登录用户的密码或身份验证令牌。
敏感属性：是
支持表达式语言：是（使用 FlowFile 属性与环境/系统变量求值）
Export Method
  • Cursor Based — 在基于游标（cursor）的增量导出中，每页结果都包含一个 "after" 游标指针，用作下一页结果的起始游标。
  • Time Based — 在基于时间（time）的增量导出中，每页结果都包含一个结束时间，用作下一页结果的起始时间。
增量导出的方法。
Resource
  • Tickets — Tickets 是最终用户（客户）在 Zendesk Support 中与客服人员沟通的方式。
  • Ticket Events — tickets 上发生的变更流。每个事件都与某个 ticket 的一次更新相关联，并包含该变更中更新的所有字段。
  • Ticket Metric Events — Ticket metric events API 可用于跟踪回复时间、客服工作时间和请求者等待时间。
  • Users — Zendesk Support 有三种类型的用户：最终用户（客户）、客服人员和管理员。
  • Organizations — 正如客服人员可以在 Zendesk Support 中被划分为组一样，客户（最终用户）可以被划分为组织。
  • Articles — Articles 是包含在各个节（section）中的内容项，例如帮助主题或技术说明。
  • NPS - Responses — 当接收者回复 NPS 调查时，会捕获其评分、评论和最后调查日期。
  • NPS - Recipients — 每个 NPS 调查都会发送给一个或多个接收者。对于大多数使用 Zendesk Support 的企业而言，接收者是客户。客服人员和管理员永远不会收到调查。
要导出的特定 Zendesk 资源。
Query Start Timestamp以 Unix 时间戳秒格式查询 Zendesk API 的初始时间戳。
支持表达式语言：是（使用 FlowFile 属性与环境/系统变量求值）

关系 (Relationships)

名称描述自动终止
success对于由于成功的 HTTP 请求而创建的 FlowFiles。否

写入的 FlowFile 属性

名称描述
record.count处理器获取的记录数。

状态管理

作用域描述
CLUSTER存储 Zendesk API 的分页光标。 每次成功请求后都会更新光标。

受限 (Restricted)

该组件不受限。

输入要求

该组件不允许有传入连接。

详细说明

GetZendesk

说明

该 Processor 使用 Zendesk Incremental Exports API，从某个任意 里程碑开始首次导出完整的条目列表，然后周期性轮询 API，增量 导出自上次轮询以来新增或变更的条目。该 Processor 从响应中 提取数据，如果响应非空，会输出一个内容为对象数组的 FlowFile，并在 FlowFile 上放置一个表示获取记录数的 Attribute。如果响应为空，则不输出 FlowFile。可以使用 SplitJson Processor 把记录数组拆分为独立的 FlowFile，每个 FlowFile 恰好包含一条记录。

认证

Zendesk Incremental Exports API 使用基本认证。必须提供 密码或认证令牌之一。认证令牌可以在 Zendesk API Settings 中创建，这样用户不必暴露密码，且在必要时可以快速吊销 认证令牌。

导出方式

Zendesk Incremental Exports API 支持基于游标（cursor）和 基于时间（time）两种导出方式。应优先使用基于游标的方式 （在可用的情况下）。由于基于时间导出的限制，结果集可能 包含重复记录。关于导出方式的更多细节参见 本指南

排除重复条目

由于基于时间的分页限制，导出的数据可能包含重复条目。该 Processor 不做去重，而是可以使用 DetectDuplicate 或 DeduplicateRecord Processor 配合 UpdateAttribute Processor， 从 FlowFile 内容中提取所需的 Attribute。细节和去重过程中 使用的 Attribute 列表参见 以下指南。

© 2026 ACAL Organization. Licensed under Apache License 2.0.