类别
类别是帮助中心中知识库的顶级组织容器。亚博官方app类别包含相关的部分．看到按类别和节组织知识库内亚博官方app容在Ze亚博ndesk帮助。
JSON格式
类别表示为具有以下属性的JSON对象:
| 名字 | 类型 | 只读 | 强制性的 | 描述 |
|---|---|---|---|---|
| created_at | 字符串 | 真正的 | 假 | 创建类别的时间 |
| 描述 | 字符串 | 假 | 假 | 类别的描述 |
| html_url | 字符串 | 真正的 | 假 | 帮助中心中此类别的url |
| id | 整数 | 真正的 | 真正的 | 在创建类别时自动分配 |
| 语言环境 | 字符串 | 假 | 真正的 | 显示类别的区域设置 |
| 名字 | 字符串 | 假 | 真正的 | 类别的名称 |
| 过时的 | 布尔 | 真正的 | 假 | 类别是否过时 |
| 位置 | 整数 | 假 | 假 | 这个类别相对于其他类别的位置 |
| source_locale | 字符串 | 真正的 | 假 | 类别的源(默认)语言环境 |
| updated_at | 字符串 | 真正的 | 假 | 类别最后更新的时间 |
| url | 字符串 | 真正的 | 假 | 此类别的API url |
例子
{“描述”：＂＂，“html_url”：“https://company.亚博zendesk.com/hc/en-us/categories/354362577”，“id”：1635，“场所”：“en - us”，“名称”：“自助文章”，“source_locale”：“en - us”，“url”：“https://company.亚博zendesk.com/api/v2/help_center/categories/354362577”}
类别列表
GET / api / v2 / help_center{/地区}/类别
请注意：{/地区}是管理员和代理的可选参数。终端用户和匿名用户必须填写。
允许
- 代理
- 最终用户
- 匿名用户
响应将只列出代理、最终用户或匿名用户可以在帮助中心查看的类别。
排序
可以对结果进行排序sort_by和sort_order查询字符串参数。
得到/api/v2/help_center/在-我们/类别．json？sort_by=updated_at＆sort_order=asc
的sort_by参数可以是以下值之一:
| 价值 | 描述 |
|---|---|
位置 |
使用“安排内容”页面手动设置的顺序。默认的顺序 |
created_at |
按创建时间排序 |
updated_at |
按更新时间排序 |
的sort_order参数可以是以下值之一:
| 价值 | 描述 |
|---|---|
asc |
升序排序 |
desc |
降序排列 |
拷贝的
支持以下副加载:
| 名字 | 将拷贝的 |
|---|---|
| 翻译 | 类别翻译(如果有的话) |
翻译被嵌入到类别中，因为它们不在资源之间共享。亚博电脑端
参数
| 名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| sort_by | 字符串 | 查询 | 假 | 按可接受的值之一对结果进行排序。取值为position、created_at或updated_at。 |
| sort_order | 字符串 | 查询 | 假 | 选择结果的顺序。允许的值为"asc"或"desc"。 |
| 语言环境 | 字符串 | 路径 | 假 | 项目显示的区域设置 |
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/v2/help_center/{语言环境}/ categories.json＼- v - u{email_address}：{密码}
去
进口（“fmt”“输入输出”“net/http”）函数主要（）{url：=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别? sort_by = &sort_order = "方法：=“获得”要求的事情，犯错：=http．NewRequest（方法，url，零）如果犯错! =零{fmt．Println（犯错）返回}要求的事情．头．添加（“内容类型”，“application / json”）要求的事情．头．添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端：=＆http．客户端{}res，犯错：=客户端．做（要求的事情）如果犯错! =零{fmt．Println（犯错）返回}推迟res．身体．关闭（）身体，犯错：=io．ReadAll（res．身体）如果犯错! =零{fmt．Println（犯错）返回}fmt．Println（字符串（身体））}
Java
进口com．squareup．okhttp．*；OkHttpClient客户端=新OkHttpClient（）；HttpUrl．构建器urlBuilder=HttpUrl．解析（“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别”）．newBuilder（）．addQueryParameter（“sort_by”，＂＂）．addQueryParameter（“sort_order”，＂＂）；请求请求=新请求．构建器（）．url（urlBuilder．构建（））．方法（“获得”，零）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应=客户端．newCall（请求）．执行（）；
Nodejs
varaxios=需要（“axios”）；var配置={方法：“得到”，url：“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别”，头：{“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，参数个数：{“sort_by”：＇＇，“sort_order”：＇＇，}，}；axios（配置）．然后（函数（响应）{控制台．日志（JSON．stringify（响应．数据））；}）．抓（函数（错误）{控制台．日志（错误）；}）；
Python
进口请求url=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别? sort_by = &sort_order = "头={“内容类型”：“application / json”，}响应=请求．请求（“获得”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应．文本）
鲁比（人名）
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别”）uri．查询=URI．encode_www_form（“sort_by”：＂＂，“sort_order”：＂＂）请求=网：：HTTP：：得到．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应=网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束
示例响应(年代)
200好了
//状态200 OK{“类别”：［{“描述”：“这个类别包含了超级英雄的技巧集合”，“id”：37486578，“场所”：“en - us”，“名称”：“超级英雄的把戏”}，{“描述”：“都是很酷的把戏!”，“id”：354675463，“场所”：“en - us”，“名称”：“提示和技巧”}］}
显示类别
GET / api / v2 / help_center{/地区}/类别/ {category_id添加}
请注意：{/地区}是管理员和代理的可选参数。终端用户和匿名用户必须填写。
允许
- 代理
- 最终用户
- 匿名用户
拷贝的
支持以下副加载:
| 名字 | 将拷贝的 |
|---|---|
| 翻译 | 类别翻译(如果有的话) |
翻译被嵌入到类别中，因为它们不在资源之间共享。亚博电脑端
参数
| 名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| category_id添加 | 整数 | 路径 | 真正的 | 类别的唯一ID |
| 语言环境 | 字符串 | 路径 | 假 | 项目显示的区域设置 |
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/v2/help_center/{语言环境}/类别/{category_id添加}. json＼- v - u{email_address}：{密码}
去
进口（“fmt”“输入输出”“net/http”）函数主要（）{url：=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别/ 360002011513”方法：=“获得”要求的事情，犯错：=http．NewRequest（方法，url，零）如果犯错! =零{fmt．Println（犯错）返回}要求的事情．头．添加（“内容类型”，“application / json”）要求的事情．头．添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端：=＆http．客户端{}res，犯错：=客户端．做（要求的事情）如果犯错! =零{fmt．Println（犯错）返回}推迟res．身体．关闭（）身体，犯错：=io．ReadAll（res．身体）如果犯错! =零{fmt．Println（犯错）返回}fmt．Println（字符串（身体））}
Java
进口com．squareup．okhttp．*；OkHttpClient客户端=新OkHttpClient（）；HttpUrl．构建器urlBuilder=HttpUrl．解析（“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别/ 360002011513”）．newBuilder（）；请求请求=新请求．构建器（）．url（urlBuilder．构建（））．方法（“获得”，零）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应=客户端．newCall（请求）．执行（）；
Nodejs
varaxios=需要（“axios”）；var配置={方法：“得到”，url：“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别/ 360002011513”，头：{“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，}；axios（配置）．然后（函数（响应）{控制台．日志（JSON．stringify（响应．数据））；}）．抓（函数（错误）{控制台．日志（错误）；}）；
Python
进口请求url=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别/ 360002011513”头={“内容类型”：“application / json”，}响应=请求．请求（“获得”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应．文本）
鲁比（人名）
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别/ 360002011513”）请求=网：：HTTP：：得到．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应=网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束
示例响应(年代)
200好了
//状态200 OK{“类别”：{“描述”：“这个类别包含了超级英雄的技巧集合”，“id”：37486578，“场所”：“en - us”，“名称”：“超级英雄的把戏”}}
创建类别
POST / api / v2 / help_center{/地区}/类别
您必须指定类别名称和区域设置。如果在URL中指定了区域设置，则可以省略该区域设置。可选地，您可以指定多个翻译对于这个类别。必须为当前帮助中心启用指定的区域设置。
允许
- 帮助中心经理
参数
| 名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| 语言环境 | 字符串 | 路径 | 假 | 项目显示的区域设置 |
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/v2/help_center/categories.json＼- d”{“类别”:{“位置”:2,“语言环境”:“en - us”、“名称”:“超级英雄的技巧”,\"description": "此类别包含超级英雄技巧的集合"}}'＼- v - u{email_address}：{密码}-x post -h“application / json内容类型:
旋度
#您也可以为新类别指定多个翻译:旋度https://{子域名}.亚博zendesk.com/api/v2/help_center/categories.json＼- d{“类别”:{“位置”:2，“翻译”:\[{“语言环境”:“en - us”,“标题”:“超级英雄的技巧”,\"body": "此类别包含超级英雄技巧集合"}，\{"locale": "fr"， "title": "Trucs Super heroes "， \"body": "创建目录目录目录目录"}]}}'＼- v - u{email_address}：{密码}-x post -h“application / json内容类型:
去
进口（“fmt”“输入输出”“net/http”）函数主要（）{url：=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别”方法：=“职位”要求的事情，犯错：=http．NewRequest（方法，url，零）如果犯错! =零{fmt．Println（犯错）返回}要求的事情．头．添加（“内容类型”，“application / json”）要求的事情．头．添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端：=＆http．客户端{}res，犯错：=客户端．做（要求的事情）如果犯错! =零{fmt．Println（犯错）返回}推迟res．身体．关闭（）身体，犯错：=io．ReadAll（res．身体）如果犯错! =零{fmt．Println（犯错）返回}fmt．Println（字符串（身体））}
Java
进口com．squareup．okhttp．*；OkHttpClient客户端=新OkHttpClient（）；HttpUrl．构建器urlBuilder=HttpUrl．解析（“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别”）．newBuilder（）；RequestBody身体=RequestBody．创建（MediaType．解析（“application / json”），＂＂＂＂＂＂）；请求请求=新请求．构建器（）．url（urlBuilder．构建（））．方法（“职位”，身体）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应=客户端．newCall（请求）．执行（）；
Nodejs
varaxios=需要（“axios”）；var配置={方法：“职位”，url：“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别”，头：{“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，}；axios（配置）．然后（函数（响应）{控制台．日志（JSON．stringify（响应．数据））；}）．抓（函数（错误）{控制台．日志（错误）；}）；
Python
进口请求url=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别”头={“内容类型”：“application / json”，}响应=请求．请求（“职位”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应．文本）
鲁比（人名）
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别”）请求=网：：HTTP：：帖子．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应=网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束
示例响应(年代)
201年创建
//状态201创建{“类别”：{“描述”：“这个类别包含了超级英雄的技巧集合”，“id”：37486578，“场所”：“en - us”，“名称”：“超级英雄的把戏”}}
更新类别
把/ api / v2 / help_center{/地区}/类别/ {category_id添加}
这些端点仅更新分类级元数据，如排序位置。他们不更新类别翻译。
允许
- 帮助中心经理
参数
| 名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| category_id添加 | 整数 | 路径 | 真正的 | 类别的唯一ID |
| 语言环境 | 字符串 | 路径 | 假 | 项目显示的区域设置 |
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/v2/help_center/categories/{category_id添加}. json＼- d'{"category": {"position": 2}}'＼- v - u{email_address}：{密码}-x放-h“application / json内容类型:
去
进口（“fmt”“输入输出”“net/http”）函数主要（）{url：=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别/ 360002011513”方法：=“把”要求的事情，犯错：=http．NewRequest（方法，url，零）如果犯错! =零{fmt．Println（犯错）返回}要求的事情．头．添加（“内容类型”，“application / json”）要求的事情．头．添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端：=＆http．客户端{}res，犯错：=客户端．做（要求的事情）如果犯错! =零{fmt．Println（犯错）返回}推迟res．身体．关闭（）身体，犯错：=io．ReadAll（res．身体）如果犯错! =零{fmt．Println（犯错）返回}fmt．Println（字符串（身体））}
Java
进口com．squareup．okhttp．*；OkHttpClient客户端=新OkHttpClient（）；HttpUrl．构建器urlBuilder=HttpUrl．解析（“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别/ 360002011513”）．newBuilder（）；RequestBody身体=RequestBody．创建（MediaType．解析（“application / json”），＂＂＂＂＂＂）；请求请求=新请求．构建器（）．url（urlBuilder．构建（））．方法（“把”，身体）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应=客户端．newCall（请求）．执行（）；
Nodejs
varaxios=需要（“axios”）；var配置={方法：“把”，url：“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别/ 360002011513”，头：{“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，}；axios（配置）．然后（函数（响应）{控制台．日志（JSON．stringify（响应．数据））；}）．抓（函数（错误）{控制台．日志（错误）；}）；
Python
进口请求url=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别/ 360002011513”头={“内容类型”：“application / json”，}响应=请求．请求（“把”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应．文本）
鲁比（人名）
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别/ 360002011513”）请求=网：：HTTP：：把．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应=网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束
示例响应(年代)
200好了
//状态200 OK{“类别”：{“描述”：“这个类别包含了超级英雄的技巧集合”，“id”：37486578，“场所”：“en - us”，“名称”：“超级英雄的把戏”}}
更新类别源语言环境
把/ api / v2 / help_center{/地区}/类别/ {category_id添加}/ source_locale
端点更新类别source_locale财产
允许
- 代理
参数
| 名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| category_id添加 | 整数 | 路径 | 真正的 | 类别的唯一ID |
| 语言环境 | 字符串 | 路径 | 假 | 项目显示的区域设置 |
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/v2/help_center/categories/{category_id添加}/ source_locale.json＼- d”{“category_locale”:“fr”}’- v - u{email_address}：{密码}- x将＼- h“application / json内容类型:
去
进口（“fmt”“输入输出”“net/http”）函数主要（）{url：=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别/ 360002011513 / source_locale”方法：=“把”要求的事情，犯错：=http．NewRequest（方法，url，零）如果犯错! =零{fmt．Println（犯错）返回}要求的事情．头．添加（“内容类型”，“application / json”）要求的事情．头．添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端：=＆http．客户端{}res，犯错：=客户端．做（要求的事情）如果犯错! =零{fmt．Println（犯错）返回}推迟res．身体．关闭（）身体，犯错：=io．ReadAll（res．身体）如果犯错! =零{fmt．Println（犯错）返回}fmt．Println（字符串（身体））}
Java
进口com．squareup．okhttp．*；OkHttpClient客户端=新OkHttpClient（）；HttpUrl．构建器urlBuilder=HttpUrl．解析（“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别/ 360002011513 / source_locale”）．newBuilder（）；RequestBody身体=RequestBody．创建（MediaType．解析（“application / json”），＂＂＂＂＂＂）；请求请求=新请求．构建器（）．url（urlBuilder．构建（））．方法（“把”，身体）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应=客户端．newCall（请求）．执行（）；
Nodejs
varaxios=需要（“axios”）；var配置={方法：“把”，url：“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别/ 360002011513 / source_locale”，头：{“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，}；axios（配置）．然后（函数（响应）{控制台．日志（JSON．stringify（响应．数据））；}）．抓（函数（错误）{控制台．日志（错误）；}）；
Python
进口请求url=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别/ 360002011513 / source_locale”头={“内容类型”：“application / json”，}响应=请求．请求（“把”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应．文本）
鲁比（人名）
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别/ 360002011513 / source_locale”）请求=网：：HTTP：：把．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应=网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束
示例响应(年代)
200好了
//状态200 OK零
删除类别
删除/ api / v2 / help_center{/地区}/类别/ {category_id添加}
警告:每个部分和类别中的所有文章也将被删除。
允许
- 帮助中心经理
参数
| 名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| category_id添加 | 整数 | 路径 | 真正的 | 类别的唯一ID |
| 语言环境 | 字符串 | 路径 | 假 | 项目显示的区域设置 |
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/v2/help_center/categories/{category_id添加}. json＼- v - u{email_address}：{密码}- x删除
去
进口（“fmt”“输入输出”“net/http”）函数主要（）{url：=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别/ 360002011513”方法：=“删除”要求的事情，犯错：=http．NewRequest（方法，url，零）如果犯错! =零{fmt．Println（犯错）返回}要求的事情．头．添加（“内容类型”，“application / json”）要求的事情．头．添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端：=＆http．客户端{}res，犯错：=客户端．做（要求的事情）如果犯错! =零{fmt．Println（犯错）返回}推迟res．身体．关闭（）身体，犯错：=io．ReadAll（res．身体）如果犯错! =零{fmt．Println（犯错）返回}fmt．Println（字符串（身体））}
Java
进口com．squareup．okhttp．*；OkHttpClient客户端=新OkHttpClient（）；HttpUrl．构建器urlBuilder=HttpUrl．解析（“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别/ 360002011513”）．newBuilder（）；请求请求=新请求．构建器（）．url（urlBuilder．构建（））．方法（“删除”，零）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应=客户端．newCall（请求）．执行（）；
Nodejs
varaxios=需要（“axios”）；var配置={方法：“删除”，url：“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别/ 360002011513”，头：{“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，}；axios（配置）．然后（函数（响应）{控制台．日志（JSON．stringify（响应．数据））；}）．抓（函数（错误）{控制台．日志（错误）；}）；
Python
进口请求url=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别/ 360002011513”头={“内容类型”：“application / json”，}响应=请求．请求（“删除”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应．文本）
鲁比（人名）
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别/ 360002011513”）请求=网：：HTTP：：删除．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应=网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束
示例响应(年代)
204无内容
//状态204无内容零