---
title: API 与集成概览
sidebarTitle: 集成概览
description: >-
  使用 OpenAPI 和交互式 Playground 编写 API 文档，以编程方式搜索文档，并连接 GitHub、Slack、分析和电子邮件工具。
---

> **For AI agents:** the complete documentation index is at [llms.txt](/docs/llms.txt). Append `.md` to any page URL for its markdown version.

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

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

## 编写 API 文档

<Columns cols={3}>
  <Card title="API Playground" icon="flask" href="/cn/api-reference/playground">
    读者可以直接从文档中测试端点，并查看实时代码示例
  </Card>
  <Card title="OpenAPI 示例" icon="file-code" href="/cn/api-reference/openapi-example">
    一个由 OpenAPI 实时生成的端点页面，以及 Jamdesk 如何呈现该页面
  </Card>
  <Card title="请求与响应示例" icon="arrow-right-arrow-left" href="/cn/api-reference/request-response-examples">
    使用 RequestExample 和 ResponseExample 组件编写 API 文档
  </Card>
</Columns>

## Jamdesk Search API

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

<Columns cols={3}>
  <Card title="文档搜索 API" icon="magnifying-glass" href="/cn/jamdesk-api/docs-search-api">
    以编程方式搜索您的文档
  </Card>
  <Card title="搜索端点" icon="code" href="/cn/jamdesk-api/search">
    `POST /_api/search` 的完整参考
  </Card>
  <Card title="集成" icon="plug" href="/cn/jamdesk-api/integrations">
    将 Search API 连接到 Intercom、Zendesk、Slack 和自定义机器人
  </Card>
</Columns>

## GitHub 与通知

<Columns cols={2}>
  <Card title="GitHub 集成" icon="github" href="/cn/integrations/github">
    用于访问代码仓库的 GitHub App，以及用于构建提醒的账户链接
  </Card>
  <Card title="Slack 集成" icon="slack" href="/cn/integrations/slack">
    在团队频道中发送构建通知
  </Card>
  <Card title="电子邮件注册" icon="envelope" href="/cn/integrations/email-signups">
    使用 Resend、Mailchimp、Kit、Loops、beehiiv、Brevo 或 SendGrid 收集注册信息
  </Card>
  <Card title="嵌入页面" icon="window-maximize" href="/cn/development/embed-page">
    在您自己的应用中添加“What's new?”按钮，打开变更日志
  </Card>
  <Card title="支持与聊天服务商" icon="comments" href="/cn/integrations/support-chat">
    Intercom 和 Front Chat 的实时聊天小组件
  </Card>
</Columns>

## 分析与同意

Jamdesk 提供无需配置的[内置分析](/cn/setup/analytics-overview)。如果您还希望在此基础上使用自己的工具，请参阅以下页面。

<Columns cols={2}>
  <Card title="Google Analytics" icon="chart-simple" href="/cn/integrations/google-analytics">
    使用测量 ID 添加 GA4
  </Card>
  <Card title="Google Tag Manager" icon="tags" href="/cn/integrations/google-tag-manager">
    在每个页面加载 GTM 容器
  </Card>
  <Card title="Plausible Analytics" icon="chart-line" href="/cn/integrations/plausible-analytics">
    注重隐私且轻量的 Google Analytics 替代方案
  </Card>
  <Card title="分析与会话回放服务商" icon="chart-mixed" href="/cn/integrations/analytics-providers">
    PostHog、Mixpanel、Amplitude、Hotjar、Clarity、Fathom、Pirsch、Heap、LogRocket、Segment、Clearbit、Hightouch 和 Koala
  </Card>
  <Card title="Cookie 同意" icon="cookie-bite" href="/cn/integrations/cookie-consent">
    在 Osano 或 Termly 同意横幅后启用分析
  </Card>
</Columns>

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