跳到主要内容
版本：Next

Zendesk

Zendesk 数据源连接器

描述​

用于从 Zendesk REST API 读取数据。它使用 Zendesk 账号邮箱和 API token 进行认证（以 HTTP Basic Authorization 请求头发送），并将某个 Zendesk 接口（如 tickets、users、organizations）读取为 SeaTunnel 的行数据。

主要特性​

选项​

名称类型是否必填默认值
urlString是-
emailString是-
api_tokenString是-
methodString否get
schemaConfig否-
formatString否text
paramsMap否-
bodyString否-
json_fieldConfig否-
content_fieldString否-
poll_interval_millisint否-
retryint否-
retry_backoff_multiplier_msint否100
retry_backoff_max_msint否10000
enable_multi_linesboolean否false
common-optionsconfig否-

url [String]​

要读取的 Zendesk REST API 接口地址，例如 https://your-subdomain.zendesk.com/api/v2/tickets.json。

email [String]​

用于 API token 认证的 Zendesk 账号邮箱。它会与 api_token 组合为 {email}/token:{api_token} 并以 HTTP Basic Authorization 请求头发送。

api_token [String]​

Zendesk API token。获取方式请参考 Zendesk API token 文档。

method [String]​

http 请求方法，仅支持 GET、POST 方法。

schema [Config]​

数据的结构，包括字段名称和字段类型。更多详情请参考 Schema Feature。

format [String]​

上游数据的格式，目前仅支持 json 和 text，默认 text。

params [Map]​

http 请求参数。

json_field [Config]​

该参数用于配置 schema，因此必须与 schema 一起使用。它将响应中的 JSON 路径映射到 schema 字段。详情和示例请参考 Http source 连接器。

content_field [String]​

该参数可以在映射为行之前，提取 JSON 响应中的某个子部分（例如顶层键 tickets 或 users 下的数组）。详情和示例请参考 Http source 连接器。

common options​

数据源插件通用参数，详情请参考 Source Common Options。

示例​

source {
  Zendesk {
    url = "https://your-subdomain.zendesk.com/api/v2/tickets.json"
    email = "agent@example.com"
    api_token = "${ZENDESK_API_TOKEN}"
    method = "GET"
    format = "json"
    content_field = "$.tickets.*"
    schema = {
      fields {
        id = bigint
        subject = string
        status = string
        priority = string
        created_at = string
        updated_at = string
      }
    }
  }
}

变更日志​

Change Log
ChangeCommitVersion