介绍
这是Zendesk联邦搜索API的参考文档,它是亚博帮助中心API.
联邦搜索允许客户查看帮助中心搜索结果中的内容,这些内容存在于帮助中心之外。有关更多信息,请参见在帮助中心设置Zend亚博esk联邦搜索在Ze亚博ndesk帮助。
这个API允许你访问以下资源:亚博电脑端
- 外部内容记录
- 外部内容来源
- 外部内容类型
使用外部内容记录API来摄取外部内容记录以进行搜索。帮助中心搜索引擎对内容进行索引和排名。当最终用户单击外部内容搜索结果时,他们将被带到外部内容记录的URL。
每个外部内容记录必须指定内容类型和来源。来源是指记录的来源,例如论坛、问题跟踪器或学习管理系统。类型指的是一种内容,例如博客文章、技术说明或bug报告。
在创建具有源和类型的内容记录之后,可以在帮助中心搜索中找到这些内容。
邮差跑进来
如果你使用Postman,你可以将Guide External Content API端点作为一个集合导入到你的Postman应用中,然后尝试不同的请求来了解API是如何工作的。点击以下按钮开始:
如果你不使用邮差,你可以注册一个免费帐户邮递员的网站并下载应用程序。有关使用Postman与Zendesk api的更多信息,请参阅亚博探索Zendesk 亚博api与邮差.
分页
这个API只支持基于游标的分页。看到使用基于游标的分页在帮助中心API文档中。
速度限制
有关速率限制的信息,请参见外部内容API限制.