API 与集成概览

本节涵盖三项工作。

编写 API 文档是指将 OpenAPI 规范渲染为读者可在浏览器中直接试用的端点页面。Jamdesk Search API 可将你的文档转化为数据源，供聊天机器人、支持工具和 AI 代理查询。集成则将文档站点与其他工具相连：Slack 构建通知、分析以及邮件订阅收集。

编写 API 文档

API Playground

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

OpenAPI 示例

一个由 OpenAPI 生成的实时端点页面，以及 Jamdesk 的渲染方式

请求与响应示例

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

借助你文档中的最新内容，在聊天机器人、Slack 机器人和 AI 代理中回答问题。

文档搜索 API

以编程方式搜索你的文档

搜索端点

POST /_api/search 的完整参考

集成

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

GitHub 集成

用于仓库访问的 GitHub App，以及用于构建提醒的账户关联

Slack 集成

在团队频道中接收构建通知

邮件订阅

使用 Resend、Mailchimp、Kit、Loops、beehiiv、Brevo 或 SendGrid 收集订阅

嵌入页面

在你自己的应用中添加一个"有什么新变化？"按钮，点击后打开你的更新日志

支持与聊天服务商

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 同意横幅控制分析功能的加载

无需手动编辑 docs.json 即可完成设置。Dashboard → Integrations 会自动写入配置块并触发重新构建（适用于已连接 GitHub 的项目）。