妆容
描述
本接口用于证件照-妆容的请求,具体效果请看以下文档详情。
版本
1.0
图片要求
图片格式:JPG,PNG
更新日志
调用 URL
正式环境:https://openapi.meitu.com/idphoto/business/v1/makeup
调用方法
POST
request 的头的类型应包含:Content-Type:application/json
权限
Credits 不能用于 API 接口扣费。开通功能及资源包购买与管理请前往 MV 控制台。
请求参数
| 参数名称 | 类型 | 最大长度 | 是否必传 | 备注 |
|---|---|---|---|---|
| out_request_id | string | 64 | 是 | 外部请求ID(唯一) |
| img_url | string | 200 | 否 | 图片URL(完整URL地址,需要urlencode处理) |
| mt_generate_id | string | 64 | 否 | 美图证件照生成ID |
| makeup_id | string | 100 | 是 | 妆容ID (联系美图商务获取) |
| custom_watermark | string | 200 | 否 | 自定义水印竖版标识(联系美图商务配置) |
| custom_watermark_transverse | string | 200 | 否 | 自定义水印横版标识(联系美图商务配置) |
| mt_check_id | string | 64 | 否 | 若合作方接入检测接口/idphoto/business/check ,会获取该接口所返回的检测标识;该标识可用于在其他图片制作接口中跳过图片上传与检测 |
注意: 1、img_url、mt_generate_id、mt_check_id必须且只能选择一个传入,接口会根据传入参数来选取制作图片; 2、该接口已内置了较为基础的图像检测能力;若合作方有更细化的检测需求,可接入检测接口/idphoto/business/check;
请求示例
{
"out_request_id":"36936",
"img_url":"https://258817.png",
"makeup_id":"meituzhuangrong"
}返回值说明
成功返回值说明
| 字段名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| code | int | 100000 | 响应状态码 |
| msg | string | 操作成功 | 提示 |
| data | object | 数据 | |
| data.img_url | string | 生成后的图片URL | |
| data.mt_generate_id | string | 美图生成ID | |
| data.sd_photo | string | 生成后的图片URL(标清) | |
| data.hd_photo | string | 生成后的图片URL(高清) | |
| data.typesetting_photo | string | 生成后的图片URL(排版) |
失败返回值说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | String | 返回的内容 |
| message | String | 错误信息 |
| code | Int | 错误代码 |
返回值示例
请求成功返回示例
Response Status:200
content-type 为 application/json; charset=utf-8
#入参mt_generate_id有值,img_url为空时:
{
"code": 100000,
"data": {
"mt_generate_id": "6917420196238201561",
"img_url": "http://biz-res-pre.zone1.meitudata.com/idphoto-private/1646220627572213824-781934.jpg",
"sd_photo": "http://biz-res-pre.zone1.meitudata.com/idphoto-private/1646220627572213824-781934.jpg",
"hd_photo": "http://biz-res-pre.zone1.meitudata.com/idphoto-private/1646220627572213824-781934.jpg",
"typesetting_photo": "http://biz-res-pre.zone1.meitudata.com/idphoto-private/1646220627572213824-781934.jpg",
},
"msg": "success"
}
#入参mt_generate_id为空,img_url有值时:
{
"code": 100000,
"data": {
"mt_generate_id": "6917420196238201561",
"img_url": "http://biz-res-pre.zone1.meitudata.com/idphoto-private/1646220627572213824-781934.jpg",
"sd_photo": "",
"hd_photo": "",
"typesetting_photo": "",
},
"msg": "success"
}返回状态码
| 状态码 | 说明 |
|---|---|
| 100000 | 成功 |
| 100001 | 参数错误 |
错误代码与信息
1、本接口涉及扣费规则、错误码、msg等内容的说明,详见 扣费&状态码说明