文档 API参考

外部内容源

使用此API定义和管理外部内容源。源指的是内容记录的来源。例如:论坛，问题跟踪器，学习管理系统。因为最终用户可以根据内容来源筛选帮助中心搜索结果，所以使用描述性名称来帮助他们理解和浏览您的内容。

有关联邦搜索的更多信息，请参见简介而且在帮助中心设置Zend亚博esk联邦搜索在Ze亚博ndesk帮助。

JSON格式

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

的名字 类型 只读 强制性的 描述
created_at 字符串 假 假 符合ISO-8601的日期-时间，反映事件创建的时间。如果未设置，API将在接收到事件时设置该值
id 字符串 真正的 假 通用唯一的字典排序标识符。看到https://github.com/ulid/spec
的名字 字符串 假 真正的 要在帮助中心中显示的源的名称
updated_at 字符串 假 假 符合ISO-8601的日期-时间，反映事件最后更新的时间

列出外部内容来源

  • 得到/ api / v2 /指导/ external_content /来源

返回为此帐户创建的外部内容源的列表。

允许

  • 帮助中心经理

参数

的名字 类型 在 要求 描述
页面 对象 查询 假 随意翻阅查询

代码示例

旋度 
              

               
旋度https://｛子域名｝.亚博zendesk.com/api/v2/guide/external_content/sources＼- v - u｛email_address｝：｛密码｝
去 
              

               
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url: =“https://support.亚博zendesk.com/api/v2/guide/external_content/sources?page=”方法: =“获得”要求的事情，犯错: =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/guide/external_content/sources”）．newBuilder（）．addQueryParameter（“页面”，＂＂）；请求请求＝新请求．构建器（）．url（urlBuilder．构建（））．方法（“获得”，零）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应＝客户端．newCall（请求）．执行（）；
Nodejs 
              

               
varaxios＝需要（“axios”）；var配置＝｛方法：“得到”，url：“https://support.亚博zendesk.com/api/v2/guide/external_content/sources”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"｝，参数个数：｛“页面”：”，｝，｝；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）｛控制台．日志（错误）；｝）；
Python 
              

               
进口请求url＝“https://support.亚博zendesk.com/api/v2/guide/external_content/sources?page=”头＝｛“内容类型”：“application / json”，｝响应＝请求．请求（“获得”，url，身份验证＝（“<用户名>”，' <密码> '），头＝头）打印（响应．文本）
Ruby 
              

               
需要“net/http”uri＝URI（“https://support.亚博zendesk.com/api/v2/guide/external_content/sources”）uri．查询＝URI．encode_www_form（“页面”：＂＂）请求＝网：：HTTP：：得到．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

200好了 
              

               
// Status 200 OK｛“元”：｛“after_cursor”：“镁”，“before_cursor”：“MQ”，“has_more”：真正的｝，“源”：［｛“created_at”：“2020 - 05 - 01 - t09:12:20z”，“id”：“01 e77r4513skx3ae8h20q0kj1k”，“名称”：“我的图书馆”，“updated_at”：“2020 - 05 - 26 t09:11:30z”｝］｝

显示外部内容源

  • GET / api / v2 /指导/ external_content /资源/ {id}

获取指定的外部源。

允许

  • 帮助中心经理

参数

的名字 类型 在 要求 描述
id 字符串 路径 真正的 源的唯一标识符

代码示例

旋度 
              

               
旋度https://｛子域名｝.亚博zendesk.com/api/v2/guide/external_content/sources/｛id｝＼- v - u｛email_address｝：｛密码｝
去 
              

               
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url: =“https://support.亚博zendesk.com/api/v2/guide/external_content/sources/01E7GZVZHBWYD50V00XDMYCMYP”方法: =“获得”要求的事情，犯错: =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/guide/external_content/sources/01E7GZVZHBWYD50V00XDMYCMYP”）．newBuilder（）；请求请求＝新请求．构建器（）．url（urlBuilder．构建（））．方法（“获得”，零）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应＝客户端．newCall（请求）．执行（）；
Nodejs 
              

               
varaxios＝需要（“axios”）；var配置＝｛方法：“得到”，url：“https://support.亚博zendesk.com/api/v2/guide/external_content/sources/01E7GZVZHBWYD50V00XDMYCMYP”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"｝，｝；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）｛控制台．日志（错误）；｝）；
Python 
              

               
进口请求url＝“https://support.亚博zendesk.com/api/v2/guide/external_content/sources/01E7GZVZHBWYD50V00XDMYCMYP”头＝｛“内容类型”：“application / json”，｝响应＝请求．请求（“获得”，url，身份验证＝（“<用户名>”，' <密码> '），头＝头）打印（响应．文本）
Ruby 
              

               
需要“net/http”uri＝URI（“https://support.亚博zendesk.com/api/v2/guide/external_content/sources/01E7GZVZHBWYD50V00XDMYCMYP”）请求＝网：：HTTP：：得到．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

200好了 
              

               
// Status 200 OK｛“源”：｛“created_at”：“2020 - 05 - 01 - t09:12:20z”，“id”：“01 e77r4513skx3ae8h20q0kj1k”，“名称”：“我的图书馆”，“updated_at”：“2020 - 05 - 26 t09:11:30z”｝｝

创建外部内容源

  • POST / api / v2 /指导/ external_content /来源

创建外部内容源。

允许

  • 帮助中心经理

参数

的名字 类型 在 要求 描述
页面 对象 查询 假 随意翻阅查询

例子的身体

             

              
｛“源”：｛“名称”：“我的图书馆”｝｝

代码示例

旋度 
              

               
旋度https://｛子域名｝.亚博zendesk.com/api/v2/guide/external_content/sources＼- d{"source": {" name": "My Library"}}＼- h“application / json内容类型:＼- u｛email_address｝：｛密码｝- x的帖子
去 
              

               
进口（“fmt”“输入输出”“net/http”“弦”）函数主要（）｛url: =“https://support.亚博zendesk.com/api/v2/guide/external_content/sources?page=”方法: =“职位”有效载荷: =字符串．NewReader（”{“源”:{"name": "My Library"｝} '）要求的事情，犯错: =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/guide/external_content/sources”）．newBuilder（）．addQueryParameter（“页面”，＂＂）；RequestBody身体＝RequestBody．创建（MediaType．解析（“application / json”），＂＂＂｛\ \“来源”：｛\“\”：\”我的图书馆\”｝｝＂＂＂）；请求请求＝新请求．构建器（）．url（urlBuilder．构建（））．方法（“职位”，身体）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应＝客户端．newCall（请求）．执行（）；
Nodejs 
              

               
varaxios＝需要（“axios”）；var数据＝JSON．stringify（｛“源”：｛“名称”：“我的图书馆”｝｝）；var配置＝｛方法：“职位”，url：“https://support.亚博zendesk.com/api/v2/guide/external_content/sources”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"｝，参数个数：｛“页面”：”，｝，数据：数据，｝；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）｛控制台．日志（错误）；｝）；
Python 
              

               
进口请求进口jsonurl＝“https://support.亚博zendesk.com/api/v2/guide/external_content/sources?page=”有效载荷＝json．加载（”““{“源”:{"name": "My Library"｝}”“”）头＝｛“内容类型”：“application / json”，｝响应＝请求．请求（“职位”，url，身份验证＝（“<用户名>”，' <密码> '），头＝头，json＝有效载荷）打印（响应．文本）
Ruby 
              

               
需要“net/http”uri＝URI（“https://support.亚博zendesk.com/api/v2/guide/external_content/sources”）uri．查询＝URI．encode_www_form（“页面”：＂＂）请求＝网：：HTTP：：帖子．新（uri，“内容类型”：“application / json”）请求．身体＝％问（｛“源”：｛“名称”：“我的图书馆”｝｝）请求．basic_auth“用户名”，“密码”响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

201年创建 
              

               
//状态201已创建｛“源”：｛“created_at”：“2020 - 05 - 01 - t09:12:20z”，“id”：“01 e77r4513skx3ae8h20q0kj1k”，“名称”：“我的图书馆”，“updated_at”：“2020 - 05 - 26 t09:11:30z”｝｝

更新外部内容源

  • 把/ api / v2 /指导/ external_content /资源/ {id}

使用请求体更新指定的外部内容源。

允许

  • 帮助中心经理

参数

的名字 类型 在 要求 描述
id 字符串 路径 真正的 源的唯一标识符

例子的身体

             

              
｛“源”：｛“名称”：“我的图书馆”｝｝

代码示例

旋度 
              

               
旋度https://｛子域名｝.亚博zendesk.com/api/v2/guide/external_content/sources/｛id｝＼- d{"source": {" name": "My Library"}}＼- h“application / json内容类型:＼- v - u｛email_address｝：｛密码｝- x将
去 
              

               
进口（“fmt”“输入输出”“net/http”“弦”）函数主要（）｛url: =“https://support.亚博zendesk.com/api/v2/guide/external_content/sources/01E7GZVZHBWYD50V00XDMYCMYP”方法: =“把”有效载荷: =字符串．NewReader（”{“源”:{"name": "My Library"｝} '）要求的事情，犯错: =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/guide/external_content/sources/01E7GZVZHBWYD50V00XDMYCMYP”）．newBuilder（）；RequestBody身体＝RequestBody．创建（MediaType．解析（“application / json”），＂＂＂｛\ \“来源”：｛\“\”：\”我的图书馆\”｝｝＂＂＂）；请求请求＝新请求．构建器（）．url（urlBuilder．构建（））．方法（“把”，身体）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应＝客户端．newCall（请求）．执行（）；
Nodejs 
              

               
varaxios＝需要（“axios”）；var数据＝JSON．stringify（｛“源”：｛“名称”：“我的图书馆”｝｝）；var配置＝｛方法：“把”，url：“https://support.亚博zendesk.com/api/v2/guide/external_content/sources/01E7GZVZHBWYD50V00XDMYCMYP”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"｝，数据：数据，｝；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）｛控制台．日志（错误）；｝）；
Python 
              

               
进口请求进口jsonurl＝“https://support.亚博zendesk.com/api/v2/guide/external_content/sources/01E7GZVZHBWYD50V00XDMYCMYP”有效载荷＝json．加载（”““{“源”:{"name": "My Library"｝}”“”）头＝｛“内容类型”：“application / json”，｝响应＝请求．请求（“把”，url，身份验证＝（“<用户名>”，' <密码> '），头＝头，json＝有效载荷）打印（响应．文本）
Ruby 
              

               
需要“net/http”uri＝URI（“https://support.亚博zendesk.com/api/v2/guide/external_content/sources/01E7GZVZHBWYD50V00XDMYCMYP”）请求＝网：：HTTP：：把．新（uri，“内容类型”：“application / json”）请求．身体＝％问（｛“源”：｛“名称”：“我的图书馆”｝｝）请求．basic_auth“用户名”，“密码”响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

200好了 
              

               
// Status 200 OK｛“源”：｛“created_at”：“2020 - 05 - 01 - t09:12:20z”，“id”：“01 e77r4513skx3ae8h20q0kj1k”，“名称”：“我的图书馆”，“updated_at”：“2020 - 05 - 26 t09:11:30z”｝｝

删除外部内容源。

  • 删除/ api / v2 /指导/ external_content /资源/ {id}

删除外部内容源。还将删除与此源关联的任何爬虫或记录。

允许

  • 帮助中心经理

参数

的名字 类型 在 要求 描述
id 字符串 路径 真正的 源的唯一标识符

代码示例

旋度 
              

               
旋度https://｛子域名｝.亚博zendesk.com/api/v2/guide/external_content/sources/｛id｝＼- v - u｛email_address｝：｛密码｝- x删除
去 
              

               
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url: =“https://support.亚博zendesk.com/api/v2/guide/external_content/sources/01E7GZVZHBWYD50V00XDMYCMYP”方法: =“删除”要求的事情，犯错: =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/guide/external_content/sources/01E7GZVZHBWYD50V00XDMYCMYP”）．newBuilder（）；请求请求＝新请求．构建器（）．url（urlBuilder．构建（））．方法（“删除”，零）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应＝客户端．newCall（请求）．执行（）；
Nodejs 
              

               
varaxios＝需要（“axios”）；var配置＝｛方法：“删除”，url：“https://support.亚博zendesk.com/api/v2/guide/external_content/sources/01E7GZVZHBWYD50V00XDMYCMYP”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"｝，｝；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）｛控制台．日志（错误）；｝）；
Python 
              

               
进口请求url＝“https://support.亚博zendesk.com/api/v2/guide/external_content/sources/01E7GZVZHBWYD50V00XDMYCMYP”头＝｛“内容类型”：“application / json”，｝响应＝请求．请求（“删除”，url，身份验证＝（“<用户名>”，' <密码> '），头＝头）打印（响应．文本）
Ruby 
              

               
需要“net/http”uri＝URI（“https://support.亚博zendesk.com/api/v2/guide/external_content/sources/01E7GZVZHBWYD50V00XDMYCMYP”）请求＝网：：HTTP：：删除．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

204无内容 
              

               
//状态204无内容零