# conch-report 接入文档

> conch-report 是独立部署的对话式报表服务。宿主系统用一个 iframe 嵌它的查看态页面，
> 所有输入走 URL 查询串，运行期交互走 postMessage。宿主不需要引包，也不限语言与框架。

## 文档

- [给 AI 的接入说明](https://report.doc.yijiangsoft.com/md/ai.md): 自包含的接入规范：URL 契约、消息协议、参考实现、自检清单、故障对照表。只读一篇的话读这篇。
- [这是什么](https://report.doc.yijiangsoft.com/md/index.md): 查看态与设计器的区别、接入要准备什么、现在还不支持什么。
- [五分钟接入](https://report.doc.yijiangsoft.com/md/guide/quickstart.md): 四步：拿链接、粘 iframe、传筛选条件、高度自适应。含可直接保存运行的完整示例。
- [链接参数](https://report.doc.yijiangsoft.com/md/guide/url.md): 保留字段与筛选条件的完整写法：各类型取值格式、空值语义、锁定、版本。
- [与宿主页面通信](https://report.doc.yijiangsoft.com/md/guide/postmessage.md): ready / height / params 与 setParams / refresh / setTheme 的消息协议。
- [外观与主题](https://report.doc.yijiangsoft.com/md/guide/theme.md): 设计令牌清单与两种换法、页头开关、窄屏堆叠、打印。
- [宿主代码示例](https://report.doc.yijiangsoft.com/md/guide/examples.md): 原生 HTML、Vue 3、React、后台框架路由页、小程序 web-view 的成品代码。
- [部署与安全](https://report.doc.yijiangsoft.com/md/guide/security.md): 允许哪些宿主嵌、谁能看到报表、数据边界、版本发布策略。
- [HTTP 接口](https://report.doc.yijiangsoft.com/md/reference/api.md): 报表列表、打开报表、取数、穿透、导出、版本列表的请求与响应。
- [常见问题](https://report.doc.yijiangsoft.com/md/reference/faq.md): 按症状排查：空白、条件不生效、双滚动条、消息收不到、数字对不上。

## 可选

- [全站正文](https://report.doc.yijiangsoft.com/llms-full.txt): 上面所有文档拼成一份，适合一次性喂进上下文。