Zendesk API对接SQL Server分页拉取全量工单方法咨询

核心错误原因 #

之前拼接参数请求失效的核心问题：Zendesk 采用游标分页机制，page[after]参数不接受数字偏移量，传入100这类数值是无效用法。该参数需要传入接口返回的专属游标字符串，和传统页码偏移的分页逻辑完全不同。

正确拉取流程 #

• 首页请求
  你使用的首页请求地址是正确的，直接发起GET请求即可：
  https://example.zendesk.com/api/v2/tickets.json?page[size]=100
  接口返回的JSON结构中，除tickets字段存储工单数据外，根节点会附带meta和links两个分页相关对象，结构参考如下：

  {
    "tickets": [/* 工单数据数组，单页最多100条 */],
    "meta": {
      "has_more": true,
      "after_cursor": "a1b2c3eyJpZCI6Nzg5MH0=",
      "before_cursor": "x9y8z7eyJpZCI6Nzc5MX0="
    },
    "links": {
      "next": "https://example.zendesk.com/api/v2/tickets.json?page[after]=a1b2c3eyJpZCI6Nzg5MH0=&page[size]=100",
      "prev": "https://example.zendesk.com/api/v2/tickets.json?page[before]=x9y8z7eyJpZCI6Nzc5MX0=&page[size]=100"
    }
  }
  

• 后续页拉取
  最稳妥的方式是直接取上一次响应中links.next字段的完整URL发起下一次请求，不需要自行拼接参数，能避免参数顺序、特殊字符编码导致的请求异常。
  如果需要手动拼接参数，规则为保留page[size]参数，同时将page[after]的值设置为上一次响应中meta.after_cursor的字符串值即可。
• 终止条件
  每次拿到响应后检查meta.has_more字段，当字段值为false时，说明已拉取完全部工单，直接终止循环即可。该方式不存在基于Unix时间拉取最多返回1000条的限制，可以覆盖全量数据。

实操注意事项 #

• 所有请求需要携带合法的认证头，格式参考：Authorization: Bearer <你的API访问令牌>，否则会返回403权限错误
• page[size]参数最大支持设置为100，传入更大的值接口会自动截断为100，无法通过调大页容量减少请求次数
• 全量拉取时建议每请求10-20页添加1秒左右的延时，避免触发Zendesk API频率限制被临时拦截
• 数据写入SQL Server时建议以工单ID作为唯一键做去重处理，避免请求重试时产生重复数据

内容的提问来源于stack exchange，提问作者Eszter