说明 SaaS 嵌入方案的适用场景、接入形态,以及授权、用户体系和回调关系。
SaaS 嵌入方案建议按 两种接入方法 来理解:
两种方法在前置步骤上是相同的,都必须先完成 OAuth + PKCE 授权,获取 access_token。区别只在于拿到 access_token 之后,后续调用的接口不同。
| 方法 | 更适合谁 | 获取 access_token 后做什么 |
|---|---|---|
| 基础版接入 | 想快速嵌入完整创作台的客户 | 调用 /oauth/saas-url 获取完整 SaaS 页面地址 |
| 组件版接入 | 想保留自身前台流程,但需要独立编辑器能力的客户 | 调用功能扩展接口,获取编辑器链接或查询历史记录 |
无论选择哪一种接入方法,前面的授权流程都一致:
注册并完成平台准备
-> 创建 SaaS 应用
-> 配置安全域名
-> OAuth 授权(PKCE)
-> 获取 access_token如果你还没有拿到 access_token,建议先阅读 基础版接入(完整业务流程) 的前半部分,那里已经把授权所需的核心接口串起来了。
基础版接入用于嵌入完整业务流页面,适合以较低改造成本快速完成产品集成。
标准流程如下:
完成公共授权流程
-> 获取 access_token
-> 调用 /oauth/saas-url
-> 获取 saas_ppt
-> 嵌入你的门户 / 工作台 / 系统页面适用场景如下:
对应文档: 基础版接入(完整业务流程)
组件版接入适用于已有业务流程、仅需在特定环节接入编辑器或独立能力页面的场景。
典型流程如下:
完成公共授权流程
-> 获取 access_token
-> 调用组件版接口生成编辑器地址
-> 在指定页面打开或跳转编辑器适用场景如下:
对应文档: 组件版接入(返回编辑器链接)
在正式上线和持续运营阶段,通常还需要补充以下能力:
该部分不一定属于首期联调范围,但通常是正式上线前必须确认的内容。
access_token 不是一回事access_token 是基础版接入和组件版接入的共同前置条件