联合搜索外部内容 API 是一个 REST API,可用于将外部内容的记录提取到 Zendesk 搜索索引中。此方法需要开发者构建并维护一个中间件层,以整合托管外部内容和帮助中心的服务或网站。要在没有开发者协助的情况下设置联合搜索,请使用外部内容搜索抓取程序。请参阅关于帮助中心联合搜索。
注意:如果您是在 2019 年 9 月 25 日之前设置的帮助中心,并且有自定义主题,则需要修改主题才能显示来自多个帮助中心的搜索结果。
使用外部内容 API 配置联合搜索
按照以下流程步骤,指导自己使用外部内容 API 在帮助中心设置联合搜索。
-
建立您与 Zendesk REST API 的整合,然后提取您要在搜索结果中显示的内容。请参阅联合搜索 API 参考文档。
-
选择您要在帮助中心搜索结果中包含和排除的内容。请参阅在帮助中心搜索结果中包含外部内容。
-
设置联合搜索的帮助中心主题。
要使外部内容显示在您帮助中心搜索的搜索结果中,您必须设置一个支持联合搜索结果的主题。为此,请使用最新版本的 Copenhagen 主题,或将旧的 {{help_center_filters}} 和 {{filters}} 助手替换为新的 {{source_filters}} 和 {{type_filters}} 助手。请参阅模板化参考文档中的搜索结果页面和帮助中心模板化指南的添加联合搜索以将外部内容包含在帮助中心搜索中。
-
根据需要配置知识结果,以便在知识搜索中包括外部内容。请参阅在背景信息面板中配置知识。