文章
文章是包含的帮助主题或技术说明等内容项部分.看到创建和编辑知识库中的文章亚博官方app在Ze亚博ndesk帮助。
指南管理员可以创建文章并编辑知识库中的所有现有文章。亚博官方app不是指南管理员的代理可以创建和编辑文章管理权限.最终用户既不能创建也不能编辑文章。看到理解向导的角色和权限.
如果在帮助中心中为一篇或多篇文章启用了内容块,那么Articles API有一定的限制。看到帮助中心API对内容块的限制.
JSON格式
物品被表示为具有以下属性的JSON对象:
的名字 | 类型 | 只读 | 强制性的 | 描述 |
---|---|---|---|---|
author_id | 整数 | 假 | 假 | 编写文章的用户的id(默认设置为在创建时发出请求的用户) |
身体 | 字符串 | 假 | 假 | 文章的HTML主体。不安全的标签和属性可能在显示前被删除。有关安全标记和属性的列表,请参见在帮助中心文章中允许使用不安全的HTML在Ze亚博ndesk帮助中 |
comments_disabled | 布尔 | 假 | 假 | 如果注释被禁用,则为True;假的,否则 |
content_tag_ids | 数组 | 假 | 假 | 附在文章上的内容标签列表 |
created_at | 字符串 | 真正的 | 假 | 文章创建的时间 |
草案 | 布尔 | 真正的 | 假 | 如果当前语言环境的翻译是草稿,则为True;否则错误。默认为False。可以在创建时设置,但不能在更新时设置。有关更新,请参见翻译 |
edited_at | 字符串 | 真正的 | 假 | 文章在其显示区域内最后一次编辑的时间 |
html_url | 字符串 | 真正的 | 假 | 帮助中心文章的网址 |
id | 整数 | 真正的 | 假 | 在创建文章时自动分配 |
label_names | 数组 | 假 | 假 | 与本文关联的标签名称数组。默认情况下不使用标签名。只适用于某些计划 |
语言环境 | 字符串 | 假 | 真正的 | 显示文章所在的区域 |
过时的 | 布尔 | 真正的 | 假 | 弃用。始终为假,因为源翻译始终是最新的翻译 |
outdated_locales | 数组 | 真正的 | 假 | 文章被标记为过时的地区 |
permission_group_id | 整数 | 假 | 真正的 | 权限组的id,它定义了谁可以编辑和发布本文 |
位置 | 整数 | 假 | 假 | 这篇文章在文章列表中的位置。默认为0 |
提升 | 布尔 | 假 | 假 | 如果这篇文章被推广,为True;否则错误。默认为False |
section_id | 整数 | 假 | 假 | 本文所属的节的id |
source_locale | 字符串 | 真正的 | 假 | 文章的源语言环境(默认) |
标题 | 字符串 | 假 | 真正的 | 文章的标题 |
updated_at | 字符串 | 真正的 | 假 | 文章最后一次更新的时间 |
url | 字符串 | 真正的 | 假 | 文章的API url |
user_segment_id | 整数 | 假 | 真正的 | 用户段的id,它定义了谁可以看到这篇文章。设置为null以使每个人都可以访问它 |
vote_count | 整数 | 真正的 | 假 | 赞成票和反对票的总数 |
vote_sum | 整数 | 真正的 | 假 | upvotes(+1)和downvotes(-1)的总和,可以是正的也可以是负的 |
例子
{
“author_id”:3465,
“comments_disabled”:假,
“id”:1635,
“场所”:“en”,
“permission_group_id”:13,
“标题”:“这篇文章”,
“user_segment_id”:12
}
文章列表
GET / api / v2 / help_center{/地区}/文章
GET / api / v2 / help_center{/地区}/类别/ {category_id添加}/文章
GET / api / v2 / help_center{/地区}/部分/ {section_id} /文章
GET / api / v2 / help_center /用户/ {user_id} /文章
GET / api / v2 / help_center /增量/文章吗?start_time = {start_time}
这些端点允许您列出Help Center中的所有文章、给定类别或部分中的所有文章,或者由特定代理撰写的所有文章。还可以列出自指定日期以来更改了元数据的所有文章开始时间.
要按内容更改而不是元数据更改列出文章,请按updated_at
文章的时间戳翻译.
{/地区}
仅对最终用户或匿名用户需要。管理员和代理可以省略它。
您还可以使用Search API列出文章。看到搜索.
允许
- 代理
- 最终用户
- 匿名用户
响应只列出请求代理、最终用户或匿名用户可以在帮助中心中查看的文章。
排序
方法对结果进行排序sort_by
而且sort_order
查询字符串参数。
得到/api/v2/help_center/在-我们/文章.json?sort_by=updated_at&sort_order=asc
的sort_by
参数可以有以下值之一:
价值 | 描述 |
---|---|
位置 |
使用“安排内容”页面手动设置订单集。默认的顺序 |
标题 |
按书名的字母顺序排序 |
created_at |
按创建时间排序 |
updated_at |
按更新时间排序 |
当按标题
,端点必须为标题指定语言环境。例子:
/ api / v2 / help_center / en - us / articles.json吗?sort_by=标题
的sort_order
参数可以有以下值之一:
价值 | 描述 |
---|---|
asc |
升序排序 |
desc |
降序排列 |
请注意,如果排序参数没有传递给区段范围的articles端点(/ api / v2 / help_center /{地区}/ {section_id} / articles.json /部分
),文章将按照section本身定义的顺序返回。看到按类别和节组织知识库内亚博官方app容有关在节上定义排序顺序的详细信息。
选项
开始时间
您可以使用增量项目端点列出自某个日期和时间以来更新的所有项目。端点取astart_time
参数。Unix纪元时间.例子:
/ api / v2 / help_center /增量/ articles.json吗?start_time=1404345231
标签的名称
属性可以指定只返回带有特定标签的项目label_names
参数。参数接受一个以逗号分隔的最多10个标签名称的列表。例子:
/ api / v2 / help_center / en - us / articles.json吗?label_names=照片,相机
只有具有所有标签的项目才会返回。例如,label_names =照片,相机
返回所有同时带有'photo'和'camera'标签的文章。如果你想要有'photo'或'camera'标签的文章,你可以使用搜索文章端点使用label_names
参数(专业和企业)。
匹配区分大小写。例如,'camera'匹配'camera',但不匹配'camera'。
拷贝的
支持以下副负载:
的名字 | 将拷贝的 |
---|---|
用户 | 作者 |
部分 | 一节 |
类别 | 类别 |
翻译 | 文章,节和类别翻译,如果有的话 |
与其他副负载不同,翻译嵌入到文章中,因为它们不在资源之间共享。亚博电脑端如果存在节和类别翻译,则仅侧载。
参数
的名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
label_names | 字符串 | 查询 | 假 | 只有具有所有标签的项目才会返回。 |
sort_by | 字符串 | 查询 | 假 | 根据接受的值之一对项目进行排序。取值为position、title、created_at、updated_at。 |
sort_order | 字符串 | 查询 | 假 | 选择结果的顺序。允许取值为asc或desc。 |
start_time | 整数 | 查询 | 假 | 您可以使用增量项目端点列出自某个日期和时间以来更新的所有项目。 |
语言环境 | 字符串 | 路径 | 假 | 显示项的区域设置 |
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/v2/help_center/{语言环境}/ articles.json\
- v - u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
"net/http”
)
函数主要(){
url:=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章? label_names = % 2 ccamera&sort_by照片= &sort_order = &start_time = 1404345231 "
方法:=“获得”
要求的事情,犯错:=http.NewRequest(方法,url,零)
如果犯错! =零{
fmt.Println(犯错)
返回
}
要求的事情.头.添加(“内容类型”,“application / json”)
要求的事情.头.添加(“授权”,“基本< auth-value >”)// Base64编码的"username:password"
客户端:=&http.客户端{}
res,犯错:=客户端.做(要求的事情)
如果犯错! =零{
fmt.Println(犯错)
返回
}
推迟res.身体.关闭()
身体,犯错:=io.ReadAll(res.身体)
如果犯错! =零{
fmt.Println(犯错)
返回
}
fmt.Println(字符串(身体))
}
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“得到”,
url:“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章”,
头:{
“内容类型”:“application / json”,
“授权”:的基本< auth-value >”,// Base64编码的"username:password"
},
参数个数:{
“label_names”:“照片% 2 ccamera”,
“sort_by”:”,
“sort_order”:”,
“start_time”:“1404345231”,
},
};
axios(配置)
.然后(函数(响应){
控制台.日志(JSON.stringify(响应.数据));
})
.抓(函数(错误){
控制台.日志(错误);
});
Python
进口请求
url=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章? label_names = % 2 ccamera&sort_by照片= &sort_order = &start_time = 1404345231 "
头={
“内容类型”:“application / json”,
}
响应=请求.请求(
“获得”,
url,
身份验证=(“<用户名>”,' <密码> '),
头=头
)
打印(响应.文本)
Ruby
需要"net/http”
uri=URI(“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章”)
uri.查询=URI.encode_www_form(“label_names”:“照片,相机”,“sort_by”:"",“sort_order”:"",“start_time”:“1404345231”)
请求=网::HTTP::得到.新(uri,“内容类型”:“application / json”)
请求.basic_auth“用户名”,“密码”
响应=网::HTTP.开始uri.主机名,uri.港口,use_ssl:真正的做|http|
http.请求(请求)
结束
示例响应(年代)
200好了
// Status 200 OK
{
“文章”:[
{
“author_id”:888887,
“草案”:真正的,
“id”:35467,
“场所”:“en”,
“permission_group_id”:123,
“标题”:“文章标题”,
“user_segment_id”:12
}
]
}
显示文章
GET / api / v2 / help_center{/地区}/文章/ {article_id}
显示项目的属性。
请注意:{/地区}
是管理员和代理的可选参数。最终用户和匿名用户必须提供该参数。
允许
- 代理
- 最终用户
- 匿名用户
拷贝的
支持以下副负载:
的名字 | 将拷贝的 |
---|---|
用户 | 作者 |
部分 | 一节 |
类别 | 类别 |
翻译 | 文章,节和类别翻译,如果有的话 |
与其他副负载不同,翻译嵌入到文章中,因为它们不在资源之间共享。亚博电脑端如果存在节和类别翻译,则仅侧载。
参数
的名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
article_id | 整数 | 路径 | 真正的 | 项目的唯一ID |
语言环境 | 字符串 | 路径 | 假 | 显示项的区域设置 |
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/v2/help_center/{语言环境}/文章/{article_id}. json\
- v - u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
"net/http”
)
函数主要(){
url:=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753”
方法:=“获得”
要求的事情,犯错:=http.NewRequest(方法,url,零)
如果犯错! =零{
fmt.Println(犯错)
返回
}
要求的事情.头.添加(“内容类型”,“application / json”)
要求的事情.头.添加(“授权”,“基本< auth-value >”)// Base64编码的"username:password"
客户端:=&http.客户端{}
res,犯错:=客户端.做(要求的事情)
如果犯错! =零{
fmt.Println(犯错)
返回
}
推迟res.身体.关闭()
身体,犯错:=io.ReadAll(res.身体)
如果犯错! =零{
fmt.Println(犯错)
返回
}
fmt.Println(字符串(身体))
}
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“得到”,
url:“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753”,
头:{
“内容类型”:“application / json”,
“授权”:的基本< auth-value >”,// Base64编码的"username:password"
},
};
axios(配置)
.然后(函数(响应){
控制台.日志(JSON.stringify(响应.数据));
})
.抓(函数(错误){
控制台.日志(错误);
});
Python
进口请求
url=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753”
头={
“内容类型”:“application / json”,
}
响应=请求.请求(
“获得”,
url,
身份验证=(“<用户名>”,' <密码> '),
头=头
)
打印(响应.文本)
Ruby
需要"net/http”
uri=URI(“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753”)
请求=网::HTTP::得到.新(uri,“内容类型”:“application / json”)
请求.basic_auth“用户名”,“密码”
响应=网::HTTP.开始uri.主机名,uri.港口,use_ssl:真正的做|http|
http.请求(请求)
结束
示例响应(年代)
200好了
// Status 200 OK
{
“文章”:{
“author_id”:3465,
“comments_disabled”:真正的,
“content_tag_ids”:[
335,
7104
],
“id”:37486578,
“场所”:“en_us”,
“permission_group_id”:123,
“位置”:42,
“提升”:假,
“标题”:“文章标题”,
“user_segment_id”:12
}
}
创建文章
POST / api / v2 / help_center{/地区}/部分/ {section_id} /文章
对象中创建项目部分.必须指定项目标题、user_segment_id和permission_group_id。必须为文章指定区域设置,可以作为API请求中的参数,也可以作为URL中的参数。必须为当前帮助中心启用指定的地区。还可以附加现有的内容标签通过它们的id或指定多个翻译.
当前用户将自动订阅文章,并在文章更改时收到通知。
当前用户必须是指定permission_group_id的成员。创建已发表文章(= false草案
或者丢失),当前用户必须拥有发布权限,这是提供的permission_group_id的一部分。否则,必须使用= true草案
.
允许
- 代理
提供一个notify_subscribers
属性的值为false将阻止文章的订阅者接收文章创建电子邮件通知。这在一次创建多篇文章时很有帮助。在JSON对象的根中指定属性,而不是在“article”对象中。
参数
的名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
语言环境 | 字符串 | 路径 | 假 | 显示项的区域设置 |
section_id | 整数 | 路径 | 真正的 | 节的唯一ID |
例子的身体
{
“文章”:{
“身体”:“使用三脚架”,
“场所”:“en - us”,
“permission_group_id”:56,
“标题”:“在弱光下拍照”,
“user_segment_id”:123
},
“notify_subscribers”:假
}
代码示例
旋度
为了清晰起见,该示例将JSON有效负载放在一个单独的文件中,cURL语句导入该文件。
article.json
{
“文章”:{
“标题”:“在弱光下拍照”,
“身体”:“使用三脚架”,
“场所”:“en - us”,
“user_segment_id”:123,
“permission_group_id”:56
},
“notify_subscribers”:假
}
与翻译
{
“文章”:{
“翻译”:[
{
“场所”:“en - us”,
“标题”:“在弱光下拍照”,
“身体”:“使用三脚架”
},
{
“场所”:“fr”,
“标题”:“在灯光下的照片评论”,
“身体”:“Utilisez un trepied”
}
],
“user_segment_id”:123,
“permission_group_id”:56
},
“notify_subscribers”:假
}
附有内容标签
{
“文章”:{
“标题”:“在弱光下拍照”,
“身体”:“使用三脚架”,
“content_tag_ids”:[335,7104],
“场所”:“en - us”,
“user_segment_id”:123,
“permission_group_id”:56
},
“notify_subscribers”:假
}
旋度片段
旋度https://{子域名}.亚博zendesk.com/api/v2/help_center/sections/{section_id}/ articles.json\
- d @article.json\
- h“application / json内容类型:- x的帖子\
- v - u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
"net/http”
“弦”
)
函数主要(){
url:=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/部分/ 360004785313 /文章”
方法:=“职位”
有效载荷:=字符串.NewReader(”{
"文章":{
"body": "Use a tripod",
“语言环境”:“en - us”,
“permission_group_id”:56岁
"title": "在弱光下拍照",
“user_segment_id”:123
},
“notify_subscribers”:假的
} ')
要求的事情,犯错:=http.NewRequest(方法,url,有效载荷)
如果犯错! =零{
fmt.Println(犯错)
返回
}
要求的事情.头.添加(“内容类型”,“application / json”)
要求的事情.头.添加(“授权”,“基本< auth-value >”)// Base64编码的"username:password"
客户端:=&http.客户端{}
res,犯错:=客户端.做(要求的事情)
如果犯错! =零{
fmt.Println(犯错)
返回
}
推迟res.身体.关闭()
身体,犯错:=io.ReadAll(res.身体)
如果犯错! =零{
fmt.Println(犯错)
返回
}
fmt.Println(字符串(身体))
}
Nodejs
varaxios=需要(“axios”);
var数据=JSON.stringify({
“文章”:{
“身体”:“使用三脚架”,
“场所”:“en - us”,
“permission_group_id”:56,
“标题”:“在弱光下拍照”,
“user_segment_id”:123
},
“notify_subscribers”:假
});
var配置={
方法:“职位”,
url:“https://support.亚博zendesk.com/api/v2/help_center{/地区}/部分/ 360004785313 /文章的,
头:{
“内容类型”:“application / json”,
“授权”:的基本< auth-value >”,// Base64编码的"username:password"
},
数据:数据,
};
axios(配置)
.然后(函数(响应){
控制台.日志(JSON.stringify(响应.数据));
})
.抓(函数(错误){
控制台.日志(错误);
});
Python
进口请求
进口json
url=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/部分/ 360004785313 /文章”
有效载荷=json.加载(”““{
"文章":{
"body": "Use a tripod",
“语言环境”:“en - us”,
“permission_group_id”:56岁
"title": "在弱光下拍照",
“user_segment_id”:123
},
“notify_subscribers”:假的
}”“”)
头={
“内容类型”:“application / json”,
}
响应=请求.请求(
“职位”,
url,
身份验证=(“<用户名>”,' <密码> '),
头=头,
json=有效载荷
)
打印(响应.文本)
Ruby
需要"net/http”
uri=URI(“https://support.亚博zendesk.com/api/v2/help_center{/地区}/部分/ 360004785313 /文章”)
请求=网::HTTP::帖子.新(uri,“内容类型”:“application / json”)
请求.身体=%问({
“文章”:{
“身体”:“使用三脚架”,
“场所”:“en - us”,
“permission_group_id”:56,
“标题”:“在弱光下拍照”,
“user_segment_id”:123
},
“notify_subscribers”:假
})
请求.basic_auth“用户名”,“密码”
响应=网::HTTP.开始uri.主机名,uri.港口,use_ssl:真正的做|http|
http.请求(请求)
结束
示例响应(年代)
201年创建
//状态201已创建
{
“文章”:{
“author_id”:3465,
“comments_disabled”:真正的,
“content_tag_ids”:[
335,
7104
],
“id”:37486578,
“场所”:“en_us”,
“permission_group_id”:123,
“位置”:42,
“提升”:假,
“标题”:“文章标题”,
“user_segment_id”:12
}
}
更新文章
把/ api / v2 / help_center{/地区}/文章/ {article_id}
把/ api / v2 / help_center /文章/ {article_id} . json
这些端点更新文章级元数据,如其促销状态或排序位置。端点不更新翻译属性,如文章的标题、正文、区域设置或草稿。看到翻译.
允许
- 代理
参数
的名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
article_id | 整数 | 路径 | 真正的 | 项目的唯一ID |
语言环境 | 字符串 | 路径 | 假 | 显示项的区域设置 |
代码示例
旋度
为了清晰起见,该示例将JSON有效负载放在一个单独的文件中,cURL语句导入该文件。
article.json
{
“文章”:{
“提升”:假,
“位置”:42,
“comments_disabled”:真正的,
“label_names”:[“照片”,“三脚架”],
“content_tag_ids”:[335,7104]
}
}
旋度片段
旋度https://{子域名}.亚博zendesk.com/api/v2/help_center/articles/{article_id}. json\
- d @article.json\
- h“application / json内容类型:- x将\
- v - u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
"net/http”
)
函数主要(){
url:=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753”
方法:=“把”
要求的事情,犯错:=http.NewRequest(方法,url,零)
如果犯错! =零{
fmt.Println(犯错)
返回
}
要求的事情.头.添加(“内容类型”,“application / json”)
要求的事情.头.添加(“授权”,“基本< auth-value >”)// Base64编码的"username:password"
客户端:=&http.客户端{}
res,犯错:=客户端.做(要求的事情)
如果犯错! =零{
fmt.Println(犯错)
返回
}
推迟res.身体.关闭()
身体,犯错:=io.ReadAll(res.身体)
如果犯错! =零{
fmt.Println(犯错)
返回
}
fmt.Println(字符串(身体))
}
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“把”,
url:“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753”,
头:{
“内容类型”:“application / json”,
“授权”:的基本< auth-value >”,// Base64编码的"username:password"
},
};
axios(配置)
.然后(函数(响应){
控制台.日志(JSON.stringify(响应.数据));
})
.抓(函数(错误){
控制台.日志(错误);
});
Python
进口请求
url=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753”
头={
“内容类型”:“application / json”,
}
响应=请求.请求(
“把”,
url,
身份验证=(“<用户名>”,' <密码> '),
头=头
)
打印(响应.文本)
Ruby
需要"net/http”
uri=URI(“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753”)
请求=网::HTTP::把.新(uri,“内容类型”:“application / json”)
请求.basic_auth“用户名”,“密码”
响应=网::HTTP.开始uri.主机名,uri.港口,use_ssl:真正的做|http|
http.请求(请求)
结束
示例响应(年代)
200好了
// Status 200 OK
{
“文章”:{
“author_id”:3465,
“comments_disabled”:真正的,
“content_tag_ids”:[
335,
7104
],
“id”:37486578,
“场所”:“en_us”,
“permission_group_id”:123,
“位置”:42,
“提升”:假,
“标题”:“文章标题”,
“user_segment_id”:12
}
}
更新文章源区域
把/ api / v2 / help_center{/地区}/ / {article_id} / source_locale文章
更新文章的source_locale
财产。源区域设置是文章的主要语言。在源语言环境中删除文章时,将删除文章的所有翻译。
端点将文章的一个翻译设置为文章的源语言环境。前面源语言环境中的文章变成了翻译,可以单独删除。
必须在“指南”中启用新的源区域设置。看到为帮助中心启用语言.您可以使用列出所有启用的区域设置和默认区域设置端点来检查启用的区域设置。
允许
- 代理
参数
的名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
article_id | 整数 | 路径 | 真正的 | 项目的唯一ID |
语言环境 | 字符串 | 路径 | 假 | 显示项的区域设置 |
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/v2/help_center/articles/{article_id}/ source_locale.json\
- d”{“article_locale”:“fr”}’- v - u{email_address}:{密码}- x将\
- h“application / json内容类型:
去
进口(
“fmt”
“输入输出”
"net/http”
)
函数主要(){
url:=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 / 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(字符串(身体))
}
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“把”,
url:“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 / source_locale”,
头:{
“内容类型”:“application / json”,
“授权”:的基本< auth-value >”,// Base64编码的"username:password"
},
};
axios(配置)
.然后(函数(响应){
控制台.日志(JSON.stringify(响应.数据));
})
.抓(函数(错误){
控制台.日志(错误);
});
Python
进口请求
url=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 / source_locale”
头={
“内容类型”:“application / json”,
}
响应=请求.请求(
“把”,
url,
身份验证=(“<用户名>”,' <密码> '),
头=头
)
打印(响应.文本)
Ruby
需要"net/http”
uri=URI(“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 / source_locale”)
请求=网::HTTP::把.新(uri,“内容类型”:“application / json”)
请求.basic_auth“用户名”,“密码”
响应=网::HTTP.开始uri.主机名,uri.港口,use_ssl:真正的做|http|
http.请求(请求)
结束
示例响应(年代)
200好了
// Status 200 OK
零
将附件批量关联到文章
POST / api / v2 / help_center{/地区}/ / {article_id} / bulk_attachments文章
一次只能将附件批量关联到一篇文章,每个请求最多关联20个附件。
要创建附件,请参见创建非关联附件.
允许
- 代理
参数
的名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
article_id | 整数 | 路径 | 真正的 | 项目的唯一ID |
语言环境 | 字符串 | 路径 | 假 | 显示项的区域设置 |
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/v2/help_center/articles/{article_id}/ bulk_attachments.json\
- d'{"attachment_ids":[10002,…]}'\
- v - u{email_address}:{密码}-x post -h“application / json内容类型:
去
进口(
“fmt”
“输入输出”
"net/http”
)
函数主要(){
url:=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 / bulk_attachments”
方法:=“职位”
要求的事情,犯错:=http.NewRequest(方法,url,零)
如果犯错! =零{
fmt.Println(犯错)
返回
}
要求的事情.头.添加(“内容类型”,“application / json”)
要求的事情.头.添加(“授权”,“基本< auth-value >”)// Base64编码的"username:password"
客户端:=&http.客户端{}
res,犯错:=客户端.做(要求的事情)
如果犯错! =零{
fmt.Println(犯错)
返回
}
推迟res.身体.关闭()
身体,犯错:=io.ReadAll(res.身体)
如果犯错! =零{
fmt.Println(犯错)
返回
}
fmt.Println(字符串(身体))
}
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“职位”,
url:“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 / bulk_attachments”,
头:{
“内容类型”:“application / json”,
“授权”:的基本< auth-value >”,// Base64编码的"username:password"
},
};
axios(配置)
.然后(函数(响应){
控制台.日志(JSON.stringify(响应.数据));
})
.抓(函数(错误){
控制台.日志(错误);
});
Python
进口请求
url=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 / bulk_attachments”
头={
“内容类型”:“application / json”,
}
响应=请求.请求(
“职位”,
url,
身份验证=(“<用户名>”,' <密码> '),
头=头
)
打印(响应.文本)
Ruby
需要"net/http”
uri=URI(“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 / bulk_attachments”)
请求=网::HTTP::帖子.新(uri,“内容类型”:“application / json”)
请求.basic_auth“用户名”,“密码”
响应=网::HTTP.开始uri.主机名,uri.港口,use_ssl:真正的做|http|
http.请求(请求)
结束
示例响应(年代)
200好了
// Status 200 OK
零
档案的文章
删除/ api / v2 / help_center{/地区}/文章/ {article_id}
将文章存档。您可以使用“帮助中心”用户界面恢复文章。看到查看和恢复存档的文章.
允许
- 代理
参数
的名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
article_id | 整数 | 路径 | 真正的 | 项目的唯一ID |
语言环境 | 字符串 | 路径 | 假 | 显示项的区域设置 |
代码示例
旋度
旋度——请求删除https://support.zendesk.com亚博/api/v2/help_center{/地区}/文章/ 360026053753\
——头“application / json内容类型:\
- u用户名:密码
旋度https://{子域名}.亚博zendesk.com/api/v2/help_center/articles/{article_id}. json\
- v - u{email_address}:{密码}- x删除
去
进口(
“fmt”
“输入输出”
"net/http”
)
函数主要(){
url:=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753”
方法:=“删除”
要求的事情,犯错:=http.NewRequest(方法,url,零)
如果犯错! =零{
fmt.Println(犯错)
返回
}
要求的事情.头.添加(“内容类型”,“application / json”)
要求的事情.头.添加(“授权”,“基本< auth-value >”)// Base64编码的"username:password"
客户端:=&http.客户端{}
res,犯错:=客户端.做(要求的事情)
如果犯错! =零{
fmt.Println(犯错)
返回
}
推迟res.身体.关闭()
身体,犯错:=io.ReadAll(res.身体)
如果犯错! =零{
fmt.Println(犯错)
返回
}
fmt.Println(字符串(身体))
}
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“删除”,
url:“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753”,
头:{
“内容类型”:“application / json”,
“授权”:的基本< auth-value >”,// Base64编码的"username:password"
},
};
axios(配置)
.然后(函数(响应){
控制台.日志(JSON.stringify(响应.数据));
})
.抓(函数(错误){
控制台.日志(错误);
});
Python
进口请求
url=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753”
头={
“内容类型”:“application / json”,
}
响应=请求.请求(
“删除”,
url,
身份验证=(“<用户名>”,' <密码> '),
头=头
)
打印(响应.文本)
Ruby
需要"net/http”
uri=URI(“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753”)
请求=网::HTTP::删除.新(uri,“内容类型”:“application / json”)
请求.basic_auth“用户名”,“密码”
响应=网::HTTP.开始uri.主机名,uri.港口,use_ssl:真正的做|http|
http.请求(请求)
结束
示例响应(年代)
204无内容
//状态204无内容
零