接入路径总览
开放平台接入从申请开始,以一条可重复验证的业务链路结束。先确认产品线,再进入对应接入路径;不要在尚未完成选型时同时阅读几套 SDK 文档。
五步完成接入
| 步骤 | 你需要完成什么 | 产出 |
|---|---|---|
| 1. 提交申请 | 在开放平台首页提交接入申请信息 | 工作人员与你确认接入需求 |
| 2. 获取凭证 | 企业认证成功后获取 App Key 和 Secret Key | 可用于鉴权的开放平台凭证 |
| 3. 选择路径 | 确认标准版下的具体接入路径 | OpenClaw、API 或 UI |
| 4. 技术联调 | 按选定路径完成最小链路 | 生成、编辑或下载能力可用 |
| 5. 上线验收 | 覆盖成功链路和关键异常状态 | 可上线的接入结果 |
1. 提交开放平台申请
在开放平台首页点击【立即申请】,填写接入申请信息。信息提交后,工作人员将在 2 个工作日内与你取得联系。
2. 保存 App Key 和 Secret Key
企业认证成功后,可在开放平台工作台查看接入所需的 App Key 和 Secret Key。请妥善保存凭证,不要把真实密钥写入前端代码、公开仓库或公开文档。
3. 确定一条主接入路径
获取凭证后,请先阅读 产品线与接入方式选择,按产品形态确认主路径:
- 选择标准版,且已在 OpenClaw 中编排工作流:继续阅读 OpenClaw 接入说明。
- 选择标准版,且要自研页面并自行编排生成链路:继续阅读 API 快速开始。
- 选择标准版,且要快速嵌入完整生成和编辑页面:继续阅读 预装版 UI 接入。
4. 跑通对应的最小链路
不同路径的最小联调目标不同:
| 产品线 / 接入方式 | 最小联调目标 | 继续阅读 |
|---|---|---|
| OpenClaw | 能触发 AiPPT skill 并下载 PPTX | OpenClaw 接入说明 |
| 拼装版 API | 能获取 token,完成任务创建、内容生成和作品导出 | API 鉴权 / API 快速开始 |
| 预装版 UI | 能获取 code,打开 iframe 并完成一次生成或编辑 | UI 鉴权 / UI 接入 |
5. 同时验证成功和失败场景
- 成功链路:至少完成一次生成、编辑或下载,并能拿到接入方需要的结果。
- 鉴权异常:
token、code或一次性code失效时,接入方能给出可理解提示。 - 初始化异常:iframe、SDK 或 OpenClaw skill 初始化失败时,能定位到配置或凭证问题。
- 生成异常:生成失败、导出失败或下载链接失效时,接入方有重试或兜底处理。
- 版本影响:上线前确认对应路径的更新日志,确认是否需要接入方改动。
联调入口
- 还没有选型:回到 产品线与接入方式选择。
- 需要统一鉴权口径:阅读 鉴权总览。
- 已确定接入路径:直接进入左侧标准版下的对应文档。
