Zendesk API Client 技术文档

本文档旨在帮助用户了解和使用 Zendesk API Client，涵盖安装指南、使用说明、API 文档以及安装方式等内容。

1. 安装指南

Zendesk API Client 可以通过 Rubygems 或 Bundler 进行安装。

使用 Rubygems 安装

在终端中运行以下命令：

gem install zendesk_api

使用 Bundler 安装

在项目的 Gemfile 中添加以下内容：

gem "zendesk_api"

然后运行 bundle install 完成安装。

2. 项目的使用说明

配置

在使用 Zendesk API Client 之前，需要进行配置。配置通过一个返回 ZendeskAPI::Client 实例的块来完成。

require 'zendesk_api'

client = ZendeskAPI::Client.new do |config|
  # 必填项：
  config.url = "<- your-zendesk-url ->" # 例如：https://yoursubdomain.zendesk.com/api/v2
  config.username = "[e-mail]"

  # 选择以下一种认证方式：
  config.token = "your zendesk token" # 基本认证或 Token 认证
  config.access_token = "your OAuth access token" # OAuth 认证

  # 可选项：
  config.retry = true # 启用自动重试
  config.raise_error_when_rate_limited = false # 当达到速率限制时是否抛出错误
  config.logger = Logger.new(STDOUT) # 设置日志输出
  config.use_resource_cache = false # 禁用资源缓存
end

基本使用

配置完成后，可以通过 ZendeskAPI::Client 实例来调用 API。

创建工单

ZendeskAPI::Ticket.create!(client, :subject => "测试工单", :comment => { :value => "这是一个测试" }, :submitter_id => client.current_user.id, :priority => "紧急")

查找工单

ticket = ZendeskAPI::Ticket.find!(client, :id => 1)

更新工单

ticket.update(:comment => { :value => "这是一个测试回复。" })
ticket.save!

删除工单

ZendeskAPI::Ticket.destroy!(client, :id => 1)

分页

ZendeskAPI::Collections 支持分页：

tickets = client.tickets.per_page(3)
page1 = tickets.fetch!
page2 = tickets.next

回调

可以为 ZendeskAPI::Client 实例添加回调，回调会在请求成功后执行：

client.insert_callback do |env|
  puts env[:response_headers]
end

3. 项目 API 使用文档

资源管理

可以通过 ZendeskAPI::Client 实例来管理资源，如创建、修改、保存和删除资源。

ticket = client.tickets[0]
ticket.priority = "紧急"
ticket.save!
ticket.destroy!

侧加载

侧加载允许在请求中同时加载相关资源，减少请求次数。

tickets = client.tickets.include(:users)
tickets.first.requester

4. 项目安装方式

使用 Rubygems 安装

gem install zendesk_api

使用 Bundler 安装

在 Gemfile 中添加：

gem "zendesk_api"

然后运行 bundle install。

通过本文档，您应该能够顺利安装、配置并使用 Zendesk API Client。如有任何问题，请参考项目的 wiki 或提交 issue。