搜索Zendesk票务API亚博

您可以使用票务API列表搜索结果端点在Zendesk中搜索票证、用户、组织和组。亚博端点使用以下请求格式:

GET / api / v2 /搜索?查询查询= {}

本文展示了如何使用端点发出搜索请求。

免责声明:亚博Zendesk提供本文仅用于指导目的。亚博Zendesk不支持本文中的示例代码。亚博Zendesk不支持第三方技术，如curl、Python、Node.js或JavaScript。

基本查询语法

搜索端点有查询参数:

…/ api / v2 / search.json吗?查询= {search_string}

进行搜索请求时，使用查询参数指定资源类型，如票据或用户。您还可以为搜索指定条件，例如“名为Jane Doe的用户”或“具有开放状态的门票”。

本节包含common的示例语法查询字符串。有关详细信息，请参见亚博Zendesk支持搜索参考在Ze亚博ndesk帮助。

重要的是:的查询下表中的字符串在使用前必须经过URL编码。看到URL编码参数值．

查询语法是如何工作的

的查询字符串语法使用以下规则:

• 的：字符是相等操作符。其他运营商包括<(大于)和>(小于)，负号-(否定)和通配符(*)字符。看到搜索操作符在Ze亚博ndesk帮助

• 双引号(”“)用于搜索短语。搜索只返回包含与短语完全匹配的记录。

• 的类型属性返回指定资源类型的记录。可能的值包括票，用户，组织,集团．看到使用'type'关键字在Ze亚博ndesk帮助

• 的状态属性返回分配给指定票证状态的票证。其他支持的属性因记录类型而异。请参阅Zendesk帮助中的以下参考指南:亚博

  • 票务属性关键词
  • 用户属性关键词
  • 组织属性关键词
  • 组属性关键词

• 日期属性，例如创建，更新,解决了，返回与特定日期相关的记录。日期格式为“YYYY-MM-DD”。看到按日期和时间搜索在Ze亚博ndesk帮助

URL编码参数值

亚博Zendesk REST api需要任何URL参数值的URL编码，包括查询参数。URL参数也称为查询参数或查询字符串。

例如，要使用控件提交搜索请求查询的价值类型:机票状态:开放,：和空格必须为URL编码，如下所示:

…/ api / v2 / search.json吗?查询＝类型%3Aticket+status%3Aopen

搜索请求示例

本节包括使用以下工具和编程语言的示例搜索请求:

• 旋度
• Python
• JavaScript与Node.js

本节中的示例使用基本身份验证。要使用基本身份验证，管理员必须在admin Center中启用密码访问。看到基本身份验证在API参考中。

为清楚起见，这些示例不处理分页。若要了解分页列表结果，请参见在列表中分页．

使用curl搜索

要在curl请求中包含URL参数，请使用- g国旗。要对参数的值进行url编码，请使用——data-urlencode选择。例子:

             

              
旋度“https://{子域名}.zendes亚博k.com/api/v2/search.json”\- g - data-urlencode“查询=类型:机票状态:开放”\- v - u{email_address}：{密码}
             

你可以使用多个- g标志在单个curl请求中包含多个URL参数。例子:

             

              
旋度“https://{子域名}.zendes亚博k.com/api/v2/search.json”\- g - data-urlencode“查询=类型:机票状态:开放”\- g“sort_by = created_at”\- g“sort_order = asc”\- v - u{email_address}：{密码}
             

有关的更多信息- g和——data-urlencode旗子，参见旋度的文档．

使用Python搜索

你可以使用请求库Python 3来发出REST API请求。该库允许您将URL参数作为Python字典传递。当它发出请求时，库自动对参数值进行url编码。

下面的Python 3脚本使用Requests库来发出搜索请求。

             

              
进口请求url＝“https://SUBDOMAIN.亚博zendesk.com/api/v2/search.json”参数个数＝{“查询”：类型:机票状态:开放的，“sort_by”：“created_at”，“sort_order”：“asc”}身份验证＝（“EMAIL_ADDRESS”，“密码”）响应＝请求．得到（url，参数个数＝参数个数，身份验证＝身份验证）打印（响应．json（））
             

在运行脚本之前，请替换以下占位符:

• “SUBDOMAIN”与您的Zendesk子亚博域名
• “EMAIL_ADDRESS”与您的Zendesk电亚博子邮件地址
• “PASSWORD”与您的Zendesk密亚博码

使用Node.js的JavaScript进行搜索

node . js是一个开发人员工具，允许您在浏览器之外运行JavaScript代码。你可以使用Axios库，用于Node.js发出REST API请求。该库允许您将URL参数作为JavaScript对象传递。当它发出请求时，库自动对参数值进行url编码。

下面的Node.js脚本使用Axios库发出搜索请求。

             

              
常量axios＝需要（“axios”）；常量url＝“https://SUBDOMAIN.亚博zendesk.com/api/v2/search.json”；常量参数个数＝{查询：“类型:票状态:开放”，sort_by：“created_at”，sort_order：“asc”，}；常量身份验证＝{用户名：“EMAIL_ADDRESS”，密码：“密码”，}；axios．得到（url，{参数个数，身份验证，}）．然后（（响应）＝＞{控制台．日志（响应．数据）；}）；
             

在运行脚本之前，请替换以下占位符:

• “SUBDOMAIN”与您的Zendesk子亚博域名
• “EMAIL_ADDRESS”与您的Zendesk电亚博子邮件地址
• “PASSWORD”与您的Zendesk密亚博码