鉴权与回调

文

DOCMEE 官方团队 发布

探索 PPT + AI 的极限，为您提供卓越技术支持！

加企微

18601790226

business@metasigncloud.com

不论您使用哪种对接方案 API 对接还是 UI_SDK 对接（iframe）都需要使用我们的 API-KEY 与我们建立安全的连接通讯

API-KEY 是代表您身份的重要信息，请在服务端使用，务必妥善保存。

获取 API-KEY

您可以调用 获取 TOKEN 接口来调用我们的 API 或通过我们提供 的 SDK 来嵌入我们的 UI.

配置回调

通过 API/UI 方式接入，每当生成完整 PPT 后会触发接口回调，由系统触发回调到集成方（可选配置，非必须）。

生成 PPT 回调

请求方式： POST

请求头（签名方式）：

x-signature： MD5(uid + pptId + apiKey)

请求 body（application/json）：

标准响应格式（application/json）：

响应结果中 ok 字段为 true 则表示集成方收到回调事件，否则为处理失败，失败后系统会在 2 分钟后重试、15 分钟后重试、1 小时后重试、4 小时后重试，最多重试 4 次。

配置服务回调或修改回调地址时，系统会发送测试请求，验证接口地址是否能正常工作，测试请求数据：

上传 PPT 模板回调

请求方式： POST

请求头（签名方式）：

x-signature： MD5(uid + templateId + apiKey)

请求 body（application/json）：

标准响应格式（application/json）：

响应结果中 ok 字段为 true 则表示集成方收到回调事件，否则为处理失败，失败后系统会在 2 分钟后重试、15 分钟后重试、1 小时后重试、4 小时后重试，最多重试 4 次。

积分计费规则

API 接入

• 生成完整 PPT 文件才会扣除 1 积分，中途放弃或者退出都不会扣积分，后续调用保存/更换模板/下载等其他接口均不扣任何积分。
• 调用 上传自定义模板 接口，扣除 2 积分（传 templateId 参数时为更新覆盖不扣积分）

UI 接入

• 生成完整 PPT 文件才扣除 1 积分，中途放弃或者退出都不会扣积分！更换模板或下载等操作均不扣任何积分。
• 自定义完整模板扣 2 积分，更新和覆盖已上传的模板不扣积分（自定义简易模板不扣积分）import DocBreadcrumb from '@/components/doc/DocBreadcrumb.tsx' import ServerCallbackUrlInput from '@/components/open-workspace/ServerCallbackUrlInput' import ApiKeyInput from '@/components/open/ApiKeyInput'