AI文本说明

概述

快麦开放平台已为公开 API 文档提供面向 AI 大模型和开发者工具的文本说明能力。开发者可以通过 Markdown 页面、llms.txt 和 llms-full.txt 获取结构化文本，让 AI 辅助理解接口能力、梳理业务对接流程、生成调用示例、排查签名问题和定位错误码。

AI文本说明用于辅助阅读和开发，不替代正式 API 文档、授权流程、接口测试和业务验收。实际接口调用仍以开放平台页面展示的接口文档为准。

适用对象

• 正在接入快麦ERP开放平台的自研商家开发者。
• 需要对接订单、商品、库存、仓储、采购、售后等业务接口的技术人员。
• 使用 AI 编程工具、智能问答工具或内部知识库检索开放平台文档的团队。
• 需要快速定位接口文档、错误码、公共参数、签名规则和业务场景说明的开发者。

支持的AI文本入口

入口	地址	说明
文档索引	https://open.kuaimai.com/llms.txt	公开文档索引，按文档分类列出可供 AI 读取的 Markdown 链接。
全量文档	https://open.kuaimai.com/llms-full.txt	全部公开文档的 Markdown 全文，适合导入 AI 工具、知识库或本地检索系统。
单页Markdown	https://open.kuaimai.com/__ai/markdown/...	当前文档页面对应的纯文本 Markdown 内容，适合复制给 AI 单独分析。
页面复制	文档页面右上角“复制页面”	一键复制当前页面的 Markdown 文本，方便粘贴到 AI 工具中。

llms.txt是什么

llms.txt 是为 AI 大模型准备的公开文档入口文件。它会把快麦开放平台的公开 API 文档、场景说明、常见问题和系统公告整理成 AI 更容易读取的文本索引。

开发者可以让 AI 先读取 llms.txt，再根据业务场景找到对应文档。例如：

请读取 https://open.kuaimai.com/llms.txt，找到“订单业务对接”“API调用方法详解”和“刷新会话”相关文档，帮我整理自建平台订单接入流程。

llms-full.txt是什么

llms-full.txt 是全部公开文档的 Markdown 全文集合。它适合以下场景：

• 将快麦开放平台公开文档导入企业内部 AI 知识库。
• 让 AI 工具一次性检索全部公开 API 文档。
• 用于本地搜索、接口梳理、文档问答和开发辅助。
• 在不了解具体接口名称时，让 AI 先从全量文档中定位相关接口。

llms-full.txt 内容较长，如果 AI 工具上下文长度有限，建议优先使用 llms.txt 找到相关文档后，再复制具体页面的 Markdown 内容。

单页Markdown说明

每个公开文档页面都会生成一个对应的 Markdown 文本地址，路径格式为：

https://open.kuaimai.com/__ai/markdown/文档路径.md

例如，API调用方法详解的 Markdown 文本地址为：

https://open.kuaimai.com/__ai/markdown/api/10-API对接说明/20-API调用方法详解.md

页面右上角的“以 Markdown 格式查看”会自动打开当前页面对应的 Markdown 文本地址。开发者通常不需要手动拼接 URL。

页面复制功能

开放平台文档页面提供面向 AI 使用的快捷操作。开发者可以在页面右上角使用“复制页面”，将当前页面正文复制为 Markdown 文本。

复制后的内容适合用于以下场景：

• 发送给 AI 工具解释接口字段含义。
• 让 AI 根据文档生成接口调用示例。
• 让 AI 对比业务需求和开放平台接口能力。
• 让 AI 整理联调步骤、异常处理和测试 Checklist。

复制页面时只会复制公开文档内容，不会包含开发者的实际授权信息、请求记录或商家业务数据。

推荐使用流程

1. 先明确需要对接的业务场景，例如订单、商品、库存、售后、仓储或采购。
2. 打开 https://open.kuaimai.com/llms.txt，找到对应分类下的文档。
3. 阅读业务场景说明，确认接口调用方向、前置条件和注意事项。
4. 打开具体 API 文档，复制页面 Markdown 给 AI 分析参数、返回值和调用方式。
5. 结合“API调用方法详解”确认公共参数、签名算法、请求地址和响应格式。
6. 使用测试公司账号或测试数据完成联调验证。
7. 上线前再次核对正式 API 权限、accessToken 有效期、刷新会话接口和异常处理逻辑。

AI可以帮助开发者做什么

• 快速判断某个业务场景应该使用哪些接口。
• 整理接口调用顺序和数据流向。
• 解释公共参数、业务参数、返回字段和错误码。
• 根据文档生成 Java、Python、PHP、C# 等语言的调用示例。
• 检查签名参数是否遗漏、排序是否正确、时间格式是否符合要求。
• 根据错误码和 trace_id 辅助排查调用失败原因。
• 将复杂接口文档整理成开发任务清单或联调 Checklist。

推荐提示词模板

业务场景梳理

你是快麦开放平台 API 对接助手。请只基于我提供的快麦开放平台文档回答，不要编造文档中没有出现的字段、接口或规则。

我的业务场景是：自建平台订单接入。

请帮我输出：
1. 需要阅读的文档列表
2. 推荐接口调用顺序
3. 每个接口的作用
4. 公共参数和签名注意事项
5. 必须提前准备的数据
6. 联调测试 Checklist
7. 常见错误和排查建议

生成调用代码

请基于以下快麦开放平台文档，生成一个 Python 调用示例。

要求：
1. 使用 hmac 签名方式
2. 公共参数包含 method、appKey、timestamp、version、session、sign_method、sign
3. 不要写死 APP Secret、accessToken 或 refreshToken
4. 用占位符表示敏感信息
5. 在代码注释中标明哪些字段需要开发者按实际业务填写
6. 如果文档没有说明某个字段，请不要自行补充

排查接口错误

请基于我提供的快麦开放平台文档和接口返回结果，帮我分析失败原因。

接口返回：
粘贴返回内容，但不要粘贴 APP Secret、accessToken、refreshToken 等敏感信息。

请输出：
1. 可能原因
2. 需要核对的参数
3. 签名相关检查项
4. 会话有效性检查项
5. 下一步排查建议

对比接口能力

我需要实现以下业务需求：
描述你的业务需求。

请基于快麦开放平台文档判断：
1. 是否有对应接口支持
2. 需要使用哪些接口
3. 哪些数据需要提前在快麦ERP维护
4. 哪些字段需要由我的系统传入
5. 哪些状态或结果需要从快麦ERP查询
6. 文档中没有明确说明的风险点

安全注意事项

请勿将以下敏感信息粘贴到公共 AI 工具中：

• APP Secret
• accessToken
• refreshToken
• 商家账号密码
• 店铺真实业务数据
• 客户手机号、地址、身份证号等个人信息
• 订单、售后、采购、库存等包含敏感经营信息的完整数据

如需让 AI 分析请求参数，请使用脱敏后的示例值。示例中的 appKey、session、secret、订单号、手机号、地址等信息都应替换为占位符。

使用限制

AI文本说明仅包含公开文档内容。未发布接口、增值接口、内部接口、商家专属配置和非公开说明不会出现在 llms.txt 或 llms-full.txt 中。

AI生成的代码和结论需要开发者自行验证。正式上线前，请务必完成接口联调、异常处理、会话刷新、签名校验、重试策略和业务验收。

如果 AI 的回答与开放平台页面文档不一致，请以开放平台页面文档为准。

建议优先阅读的文档

文档	建议阅读原因
接入指南	了解 API 权限申请、测试账号、令牌有效期和基础注意事项。
API调用方法详解	了解请求地址、公共参数、签名算法、请求方式和响应结构。
刷新会话(必接)	了解如何延长 accessToken 会话有效期，避免会话过期影响接口调用。
API错误码解释	根据错误码快速判断参数、签名、会话或权限问题。
通用字段说明	理解订单、商品、库存等业务中的通用字段含义。
API场景说明	按业务流程理解接口调用方向、接口组合和注意事项。
具体接口文档	确认接口名称、业务参数、返回结果和接口限制。

常见问题

llms.txt和llms-full.txt有什么区别

llms.txt 是文档索引，适合让 AI 快速找到相关文档。llms-full.txt 是全文合集，适合导入知识库或让 AI 做全量检索。

AI文本说明是否可以直接调用接口

不可以。AI文本说明只是文档文本入口。实际接口调用仍需要申请 API 权限，并使用 APP Key、APP Secret、accessToken、签名和业务参数访问开放平台网关。

页面Markdown和网页文档内容是否一致

页面Markdown由站点构建时从公开 Markdown/MDX 文档生成，会保留正文、标题、表格和代码块，并移除页面组件相关内容。它用于帮助 AI 更稳定地读取文档正文。

可以把APP Secret发给AI帮我调试吗

不建议，也不允许在公共 AI 工具中暴露敏感凭证。请使用脱敏占位符，并只让 AI 分析签名规则、参数顺序和代码逻辑。

AI生成的接口代码可以直接上线吗

不建议直接上线。AI生成代码只能作为开发参考，必须经过本地测试、测试公司账号联调、异常场景验证和正式环境灰度验证。