美图设计室:AI商拍WebSDK
描述
美图设计室AI商拍SDK集成 AI模特、AI试衣、服装换色功能,支持在线试衣、服装颜色替换及智能模特生成,助力电商与设计场景实现高效智能化拍摄。
示例demo
https://public.static.meitudata.com/xiuxiu-pc/image-editor-sdk/3.0.0/demo/aicp.html
SDK说明
版本
3.6.3
支持浏览器
Chrome 及其他现代浏览器
支持接入方式
- 企业级深度合作接入(统一账号授权登录)
- 普通接入(暂未开放)
接入前准备
获取 Access Key
- 您需要前往美图AI开放平台登录并注册账号。
- 进入访问秘钥管理页面。
- 点击「创建秘钥」按钮,生成并获取您的 Access Key。
Access Key 是 SDK 鉴权的核心凭证,请妥善保管,避免泄露。
静默登录配置
- 您需要开通局部重绘WebSDK功能。
- 在「概览页」进入 服务列表,点击「静默登录授权」。
- 在 应用白名单地址 中填写您计划嵌入 SDK 的网站域名。
- 在 应用静默登录地址 中配置您的静默登录回调地址。
接入方式请参考:《美图产品 (Web) 静默登录接入文档》
快速开始
引入SDK
SDK 提供两种接入方式:NPM 安装 或 CDN 引入。 请根据您的项目环境选择对应方式。
方式一:通过 NPM 安装
# 安装 SDK
npm i mt-image-editor-sdk// 导入 SDK 模块
import MTImageEditor, { MTImageEditorClass } from 'mt-image-editor-sdk';
// 从 3.0.0 版本开始,支持多实例(multi-instance)模式
// 初始化方式与单例模式相同
const MTEditor1 = new MTImageEditorClass();
MTEditor1.init({...});方式二:通过 CDN 引入
<script src="https://public.static.meitudata.com/xiuxiu-pc/image-editor-sdk/3.0.0/dist/index.min.js"></script>初始化与调用
建议在页面加载完成后立即初始化 SDK,以提高首次打开速度。
MTImageEditor.init({
// 必填:在美图开放平台申请的鉴权密钥
accessKey: 'your_access_key',
// 静默登录 key
appKey: 'your_app_key',
// 必填:指定接入模块
moduleName: 'ai-commercial-photography-sdk',
// 启用静默登录时必填,参考下方登录文档
// https://titan-h5.meitu.com/xiuxiu-pc/design-open/doc/美图产品(web)静默登录接入文档v0.1.pdf
code: '',
// 可选:SDK 标题
title: '美图设计室 — AI 商拍',
// 可选:挂载节点,不传则以弹窗形式展示
el: '',
// 可选:是否启用全屏功能
fullscreen: true,
// 可选:是否在 window.onresize 时自适应尺寸
resizeAble: true,
// 业务扩展参数(非必填)
extraInfo: {
/**
* [可选参数] 模特试衣业务使用,指定要展示的子功能。
* 若不传或为空,将展示全部功能。
* @type {Array<'model' | 'clothes' | 'wig'>}
* - model:模特图
* - clothes:服装图
* - wig:假发图
*/
modelFunctionSet: ['model'],
/**
* [可选参数] 默认进入的业务模块。
* 若未填写,默认进入所购买的功能模块。
* @type {'product' | 'portrait' | 'model' | 'clothes' | 'wig' | 'recolor'}
*/
redirect: 'product',
/**
* [可选参数] 要展示的功能集合。
* 若不传或为空,将展示全部功能。
* @type {Array<'product' | 'portrait' | 'model' | 'clothes' | 'wig' | 'recolor'>}
*/
functionSet: ['product', 'portrait'],
/**
* [可选参数] 是否阻止下载默认事件。
* 0:允许下载;1:阻止下载。
*/
downloadPreventDefault: 1,
/**
* [可选参数] 自定义下载按钮文案。
*/
customDownloadText: '自定义',
/**
* [可选参数] 图片打开失败的回调。
*/
onError: (data) => console.log('图片打开失败', data),
},
});
SDK 方法说明
打开图片
// 通过点击按钮,打开指定图片
// 可以传入额外的业务参数,来指定打开的模块,如未指定,会用初始化SDK时配置的业务参数
// redirect:含义同初始化SDK时配置的业务参数redirect
MTImageEditor.openImage(URL, {
redirect?: 'product' | 'model' | 'clothes' | 'wig' | 'recolor'
});支持多图传入
MTImageEditor.openImage([
'https://xiuxiu-pro-pre.meitudata.com/ai_product/58494ab25ef237f9822a3bd1774b4ae3.jpeg',
'https://xiuxiu-pro.meitudata.com/ai_material/static/13-ui.png',
'https://xiuxiu-pro.meitudata.com/ai_material/static/33-ui.png',
'https://xiuxiu-pro.meitudata.com/ai_material/static/4-ui.png',
]);事件与回调
保存图片
MTImageEditor.saveImage((base64, type) => {
console.log('图片类型:', type); // jpg | png
console.log('图片数据:', base64);
});
监听 AIGC 任务状态
// AIGC 任务开始
MTImageEditor.onAigcStart(({ taskId }) => {
console.log('AI 生成任务开始,taskId:', taskId);
});
// AIGC 任务完成
MTImageEditor.onAigcFinish(({ taskId, urls }) => {
console.log('AI 生成完成:', urls);
// urls 为结果图美图 CDN 地址,建议自行转存
});
弹窗控制
MTImageEditor.openImage(); // 打开弹窗
MTImageEditor.close(); // 关闭弹窗
MTImageEditor.onClose(() => {
console.log('弹窗已关闭');
});
功能说明
| 功能 | 方法名 | 说明 |
|---|---|---|
| 初始化 SDK | MTImageEditor.init() | 初始化编辑器实例 |
| 打开图片 | MTImageEditor.openImage() | 打开单图或多图编辑 |
| 保存图片 | MTImageEditor.saveImage() | 获取生成的图片数据 |
| 监听生成 | onAigcStart / onAigcFinish | 监听 AI 任务状态 |
| 控制弹窗 | openImage / close | 打开或关闭编辑器弹窗 |
| 关闭回调 | onClose | 监听关闭事件 |
参数说明
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | accessKey | String | 从美图开放平台申请的鉴权密钥,用于 SDK 请求验证。 |
| 必选 | appKey | String | 应用唯一标识,对应开放平台静默登录的应用 appid。 |
| 必选 | accessKey | String | 从美图开放平台申请的鉴权密钥,用于 SDK 请求验证。 |
| 必选 | moduleName | String | 指定接入的服务模块名称。当前支持:ai-commercial-photography-sdk(AI 商拍)。 |
| 可选 | code | String | 若启用美图静默登录,则需填写静默登录返回的授权码。code的生成方式请参考《美图产品(web)静默登录接入文档》 |
| 可选 | title | String | 编辑器窗口标题,默认为 “美图设计室 - AI 商拍”。 |
| 可选 | el | String | SDK 挂载的 DOM 容器选择器。不填则以弹窗形式展示。 |
| 可选 | fullscreen | Boolean | 是否开启全屏模式,默认为 true。 |
| 可选 | resizeAble | Boolean | 是否在浏览器窗口大小变化时自适应调整,默认为 true。 |
| 可选 | extraInfo | Object | 业务扩展配置项,详见下方 extraInfo 参数说明。 |
extraInfo 参数说明
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 可选 | modelFunctionSet | Array | 模特试衣业务使用的子功能集合。 若不传或为空则展示全部功能。 ⚠️ 该属性后续将弃用,请使用 functionSet 替代。 |
| 可选 | redirect | String | 默认进入的模块页面。若未填写,将自动定位到所购买的模块。 例如: 'product'(商品图)、'recolor'(换色)等。 |
| 可选 | functionSet | Array | 要展示的功能集合。若不传或为空,将展示全部功能。 常用值示例: ['product', 'portrait']。 |
| 可选 | downloadPreventDefault | Number | 是否阻止下载按钮的默认事件。0:允许下载;1:阻止下载。 |
| 可选 | customDownloadText | String | 自定义下载按钮的文案。例如:"立即下载"。 |
| 可选 | onError | - | 打开图片失败时触发的回调函数。 参数 data 为错误信息对象。 |
常见问题
| 问题 | 可能原因 | 解决方法 |
|---|---|---|
| 初始化时报错 “403” | 域名未授权或 key 不匹配 | 检查白名单配置及 accessKey |
| 页面无法加载编辑器 | SDK 地址或网络异常 | 检查 CDN 链接是否正确 |
| 登录验证失败 | code 已过期 | 重新请求静默登录凭证 |
注意事项
- 风险提示:【生成记录】、【我的图片】数据根据 uid 隔离,建议每个用户用不同 id 访问使用。
版本
| 时间 | 版本号 | 描述 |
|---|---|---|
| 2025-12-20 | 3.6.3 | 域名.com 切换.cn |
| 2025-11-11 | 3.6.2 | sdk支持静默登录 |
| 2025-07-16 | 3.6.0 | sdk 兼容多实例 |
| 2024-09-26 | 3.4.0 | openImage支持多图传入 |
| 2024-08-07 | 3.3.5 | 新增商拍自定义下载文案、阻止下载、openImage错误回调 |
| 2024-06-13 | 3.2.0 | 美图设计室域名修改为:www.designkit.com |
| 2024-06-03 | 3.1.0 | 支持 aigc 生成开始和结束回调 |
| 2024-04-16 | 2.4.3 | 统一商拍 SDK,支持业务参数 |
| 2023-05-30 | 2.0.2 | 添加域名白名单支持 |
联系方式
如有技术问题或接入咨询,请联系美图开放平台技术支持: 美图AI开放平台