API 与集成概览

本节涵盖三项不同的工作，了解自己需要哪一项会很有帮助。

编写 API 文档意味着将 OpenAPI 规范呈现为端点页面，读者可以直接在浏览器中试用。Jamdesk Search API 则反其道而行：您的文档会成为数据源，聊天机器人、支持工具和 AI 代理可以从中查询信息。而集成则将您的文档站点连接到周边工具，从 Slack 中的构建通知到分析和电子邮件收集。

编写 API 文档

API Playground

读者可以直接从文档中测试端点，并查看实时代码示例

OpenAPI 示例

一个由 OpenAPI 实时生成的端点页面，以及 Jamdesk 如何呈现该页面

请求与响应示例

使用 RequestExample 和 ResponseExample 组件编写 API 文档

Jamdesk Search API

利用您自己的文档中的最新答案，为聊天机器人、Slack 机器人和 AI 代理提供支持。

文档搜索 API

以编程方式搜索您的文档

搜索端点

POST /_api/search 的完整参考

集成

将 Search API 连接到 Intercom、Zendesk、Slack 和自定义机器人

GitHub 与通知

GitHub 集成

用于访问代码仓库的 GitHub App，以及用于构建提醒的账户链接

Slack 集成

在团队频道中发送构建通知

电子邮件注册

使用 Resend、Mailchimp、Kit、Loops、beehiiv、Brevo 或 SendGrid 收集注册信息

嵌入页面

在您自己的应用中添加“What's new?”按钮，打开变更日志

支持与聊天服务商

Intercom 和 Front Chat 的实时聊天小组件

分析与同意

Jamdesk 提供无需配置的内置分析。如果您还希望在此基础上使用自己的工具，请参阅以下页面。

Google Analytics

使用测量 ID 添加 GA4

Google Tag Manager

在每个页面加载 GTM 容器

Plausible Analytics

注重隐私且轻量的 Google Analytics 替代方案

分析与会话回放服务商

PostHog、Mixpanel、Amplitude、Hotjar、Clarity、Fathom、Pirsch、Heap、LogRocket、Segment、Clearbit、Hightouch 和 Koala

Cookie 同意

在 Osano 或 Termly 同意横幅后启用分析

以上所有内容都可以通过 Dashboard → Integrations 进行配置，无需手动修改 docs.json：该操作会为您写入配置块并触发重新构建（适用于已连接 GitHub 的项目）。