部分包含相关文章。看到按类别和节组织知识库内亚博官方app容在Ze亚博ndesk帮助。

JSON格式

section被表示为具有以下属性的JSON对象:

名字 类型 只读 强制性的 描述
category_id添加 整数 此节所属类别的id
created_at 字符串 真正的 创建节的时间
描述 字符串 该部分的描述
html_url 字符串 真正的 这部分的url在HC中
id 整数 真正的 在创建订阅时自动分配
语言环境 字符串 真正的 显示部分的区域设置
名字 字符串 真正的 节的名称
过时的 布尔 真正的 该部分是否过时
parent_section_id 整数 该节所属的节的id。仅适用于Guide Enterprise客户
位置 整数 该部分在部分列表中的位置。当排序设置为“手动”时使用。默认情况下,该节被添加到列表的末尾
source_locale 字符串 真正的 节的源(默认)区域设置
theme_template 字符串 用于在帮助中心中显示此部分的主题模板名称。
updated_at 字符串 真正的 该部分最后更新的时间
url 字符串 真正的 本节的API url

例子

             
“category_id添加”3465“描述”“这部分包含了空中飞行的技巧”“id”1635“场所”“en - us”“名称”“航空”}

列表部分

  • GET / api / v2 / help_center{/地区}/部分
  • GET / api / v2 / help_center /{地区}/类别/ {category_id添加}/部分

在“帮助中心”或特定的类别

{地区}仅对最终用户和匿名用户需要。管理员和代理可以忽略它。

允许

  • 代理
  • 最终用户
  • 匿名用户

响应将只列出请求代理、最终用户或匿名用户可以在帮助中心查看的部分。

排序

可以对结果进行排序sort_bysort_order查询字符串参数。

             
得到/api/v2/help_center/-我们/部分jsonsort_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/语言环境}/ sections.json- v - uemail_address}密码}
              
进口“fmt”“输入输出”“net/http”函数主要url:=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/章节? sort_by = &sort_order = "方法:=“获得”要求的事情犯错:=httpNewRequest方法url如果犯错! =fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=&http客户端}res犯错:=客户端要求的事情如果犯错! =fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! =fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttp*OkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/v2/help_center{/地区}/部分”newBuilderaddQueryParameter“sort_by”""addQueryParameter“sort_order”""请求请求=请求构建器urlurlBuilder构建方法“获得”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配置然后函数响应控制台日志JSONstringify响应数据}函数错误控制台日志错误}
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查询=URIencode_www_form“sort_by”""“sort_order”""请求=HTTP得到uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应=HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK“部分”“category_id添加”888887“描述”"本节载有有关飞行仪器的文章"“id”35467“场所”“en - us”“名称”“航空”}“category_id添加”887285“描述”“本节包含供飞行员使用的天气资源”亚博电脑端“id”36169“场所”“en - us”“名称”“天气”}]}

显示部分

  • GET / api / v2 / help_center{/地区}/部分/ {section_id}

请注意{/地区}是管理员和代理的可选参数。终端用户和匿名用户必须填写。

允许

  • 代理
  • 最终用户
  • 匿名用户

拷贝的

支持以下副加载:

名字 将拷贝的
类别 类别
翻译 章节和类别的翻译(如果有的话)

与其他副负载不同,翻译被嵌入到节中,因为它们不是在资源之间共享的。亚博电脑端类别翻译只在类别被加载时才会被加载。

参数

名字 类型 要求 描述
语言环境 字符串 路径 项目显示的区域设置
section_id 整数 路径 真正的 节的唯一ID

代码示例

旋度
              
旋度https://子域名}.亚博zendesk.com/api/v2/help_center/语言环境}/部分/section_id}. json- v - uemail_address}密码}
              
进口“fmt”“输入输出”“net/http”函数主要url:=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/部分/ 360004785313”方法:=“获得”要求的事情犯错:=httpNewRequest方法url如果犯错! =fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=&http客户端}res犯错:=客户端要求的事情如果犯错! =fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! =fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttp*OkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/v2/help_center{/地区}/部分/ 360004785313”newBuilder请求请求=请求构建器urlurlBuilder构建方法“获得”addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应=客户端newCall请求执行
Nodejs
              
varaxios=需要“axios”var配置=方法“得到”url“https://support.亚博zendesk.com/api/v2/help_center{/地区}/部分/ 360004785313”“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"}}axios配置然后函数响应控制台日志JSONstringify响应数据}函数错误控制台日志错误}
Python
              
进口请求url=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/部分/ 360004785313”=“内容类型”“application / json”}响应=请求请求“获得”url身份验证=“<用户名>”' <密码> '=打印响应文本
鲁比(人名)
              
需要“net/http”uri=URI“https://support.亚博zendesk.com/api/v2/help_center{/地区}/部分/ 360004785313”请求=HTTP得到uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应=HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK“节”“描述”"本节载有有关飞行仪器的文章"“id”3457836“场所”“en - us”“名称”“航空”“位置”2}}

创建部分

  • POST / api / v2 / help_center{/地区}/类别/ {category_id添加}/部分

在给定中创建一个节类别。您必须指定节名和区域设置。如果在URL中指定了区域设置,则可以省略该区域设置。可选地,您可以指定多个翻译对于这个部分。必须为当前帮助中心启用指定的区域设置。

允许

  • 代理

参数

名字 类型 要求 描述
category_id添加 整数 路径 真正的 类别的唯一ID
语言环境 字符串 路径 项目显示的区域设置

代码示例

旋度
              
旋度https://子域名}.亚博zendesk.com/api/v2/help_center/categories/category_id添加}/ sections.json- d“{”一节”:{“位置”:2,“语言环境”:“en - us”,“名字”:“航空”,\"description": "本节包含有关飞行仪器的文章"}}"- v - uemail_address}密码}-x post -h“application / json内容类型:你也可以为新的section指定多个翻译:旋度https://子域名}.亚博zendesk.com/api/v2/help_center/categories/category_id添加}/ sections.json- d{"section": {"position": 2, "translations": \[{"locale": "en-us", "title": "Avionics", \"body": "本节包含有关飞行仪表的文章"},\{"locale": "fr", "title": "Avionique", \"body": "条目目录"}]}}"- v - uemail_address}密码}-x post -h“application / json内容类型:
              
进口“fmt”“输入输出”“net/http”函数主要url:=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别/ 360002011513 /部分”方法:=“职位”要求的事情犯错:=httpNewRequest方法url如果犯错! =fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=&http客户端}res犯错:=客户端要求的事情如果犯错! =fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! =fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttp*OkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/v2/help_center{/地区}/类别/ 360002011513 /部分”newBuilderRequestBody身体=RequestBody创建MediaType解析“application / json”""""请求请求=请求构建器urlurlBuilder构建方法“职位”身体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配置然后函数响应控制台日志JSONstringify响应数据}函数错误控制台日志错误}
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请求请求结束

示例响应(年代)

201年创建
              
//状态201创建“节”“描述”"本节载有有关飞行仪器的文章"“id”3457836“场所”“en - us”“名称”“航空”“位置”2}}
400错误请求
              
//状态400错误请求“错误”“parent_section_id”"不能在此指南计划上分配非空值"]}}

更新部分

  • 把/ api / v2 / help_center{/地区}/部分/ {section_id}

更新部分。该端点更新节级数据,具体如下:

  • 名称(在源语言环境中)
  • 描述(在源语言环境中)
  • 位置
  • 排序
  • category_id添加
  • parent_section_id
  • theme_template

要更新非源部分翻译,请参见翻译

允许

  • 帮助中心经理

参数

名字 类型 要求 描述
语言环境 字符串 路径 项目显示的区域设置
section_id 整数 路径 真正的 节的唯一ID

例子的身体

             
“节”“位置”3.}}

代码示例

旋度
              
旋度https://子域名}.亚博zendesk.com/api/v2/help_center/sections/section_id}. json- d'{"section": {"position": 42}}'- v - uemail_address}密码}-x放-h“application / json内容类型:
              
进口“fmt”“输入输出”“net/http”“弦”函数主要url:=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/部分/ 360004785313”方法:=“把”有效载荷:=字符串NewReader”{“节”:{“位置”:3}} '要求的事情犯错:=httpNewRequest方法url有效载荷如果犯错! =fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=&http客户端}res犯错:=客户端要求的事情如果犯错! =fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! =fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttp*OkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/v2/help_center{/地区}/部分/ 360004785313”newBuilderRequestBody身体=RequestBody创建MediaType解析“application / json”""\ \”一节”\“\”3.}}""请求请求=请求构建器urlurlBuilder构建方法“把”身体addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应=客户端newCall请求执行
Nodejs
              
varaxios=需要“axios”var数据=JSONstringify“节”“位置”3.}}var配置=方法“把”url“https://support.亚博zendesk.com/api/v2/help_center{/地区}/部分/ 360004785313”“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"}数据数据}axios配置然后函数响应控制台日志JSONstringify响应数据}函数错误控制台日志错误}
Python
              
进口请求进口jsonurl=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/部分/ 360004785313”有效载荷=json加载”““{“节”:{“位置”:3}}”“”=“内容类型”“application / json”}响应=请求请求“把”url身份验证=“<用户名>”' <密码> '=json=有效载荷打印响应文本
鲁比(人名)
              
需要“net/http”uri=URI“https://support.亚博zendesk.com/api/v2/help_center{/地区}/部分/ 360004785313”请求=HTTPuri“内容类型”“application / json”请求身体=“节”“位置”3.}}请求basic_auth“用户名”“密码”响应=HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK“节”“描述”"本节载有有关飞行仪器的文章"“id”3457836“场所”“en - us”“名称”“航空”“位置”2}}
400错误请求
              
//状态400错误请求“错误”“parent_section_id”"会导致一个循环"]}}

更新部分源语言环境

  • 把/ api / v2 / help_center{/地区}/ {section_id} / source_locale /部分

此端点允许您将部分的源语言设置为帮助中心的默认语言以外的其他语言。例如,如果帮助中心的默认语言是英语,但是知识库中有一个只针对日本客户的部分,则可以将该部分的源语言环境设置为“ja”。

允许

  • 帮助中心经理

参数

名字 类型 要求 描述
语言环境 字符串 路径 项目显示的区域设置
section_id 整数 路径 真正的 节的唯一ID

代码示例

旋度
              
旋度https://子域名}.亚博zendesk.com/api/v2/help_center/sections/section_id}/ source_locale.json- d”{“section_locale”:“fr”}’- v - uemail_address}密码}- x将- h“application / json内容类型:
              
进口“fmt”“输入输出”“net/http”函数主要url:=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/部分/ 360004785313 / source_locale”方法:=“把”要求的事情犯错:=httpNewRequest方法url如果犯错! =fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=&http客户端}res犯错:=客户端要求的事情如果犯错! =fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! =fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttp*OkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/v2/help_center{/地区}/部分/ 360004785313 / source_locale”newBuilderRequestBody身体=RequestBody创建MediaType解析“application / json”""""请求请求=请求构建器urlurlBuilder构建方法“把”身体addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应=客户端newCall请求执行
Nodejs
              
varaxios=需要“axios”var配置=方法“把”url“https://support.亚博zendesk.com/api/v2/help_center{/地区}/部分/ 360004785313 / source_locale”“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"}}axios配置然后函数响应控制台日志JSONstringify响应数据}函数错误控制台日志错误}
Python
              
进口请求url=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/部分/ 360004785313 / source_locale”=“内容类型”“application / json”}响应=请求请求“把”url身份验证=“<用户名>”' <密码> '=打印响应文本
鲁比(人名)
              
需要“net/http”uri=URI“https://support.亚博zendesk.com/api/v2/help_center{/地区}/部分/ 360004785313 / source_locale”请求=HTTPuri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应=HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK

删除部分

  • 删除/ api / v2 / help_center{/地区}/部分/ {section_id}

警告:该部分的所有文章也将被删除。

允许

  • 帮助中心经理

参数

名字 类型 要求 描述
语言环境 字符串 路径 项目显示的区域设置
section_id 整数 路径 真正的 节的唯一ID

代码示例

旋度
              
旋度https://子域名}.亚博zendesk.com/api/v2/help_center/sections/section_id}. json- v - uemail_address}密码}- x删除
              
进口“fmt”“输入输出”“net/http”函数主要url:=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/部分/ 360004785313”方法:=“删除”要求的事情犯错:=httpNewRequest方法url如果犯错! =fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=&http客户端}res犯错:=客户端要求的事情如果犯错! =fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! =fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttp*OkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/v2/help_center{/地区}/部分/ 360004785313”newBuilder请求请求=请求构建器urlurlBuilder构建方法“删除”addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应=客户端newCall请求执行
Nodejs
              
varaxios=需要“axios”var配置=方法“删除”url“https://support.亚博zendesk.com/api/v2/help_center{/地区}/部分/ 360004785313”“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"}}axios配置然后函数响应控制台日志JSONstringify响应数据}函数错误控制台日志错误}
Python
              
进口请求url=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/部分/ 360004785313”=“内容类型”“application / json”}响应=请求请求“删除”url身份验证=“<用户名>”' <密码> '=打印响应文本
鲁比(人名)
              
需要“net/http”uri=URI“https://support.亚博zendesk.com/api/v2/help_center{/地区}/部分/ 360004785313”请求=HTTP删除uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应=HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

204无内容
              
//状态204无内容