证件照换装

描述

本接口用于给证件照更换服装

使用流程



导入图片规范


无人像Alpha信息jpg/png

带人像Alpha信息png

图例

Alpha信息

是否需要抠图

需要抠图服务

不用抠图服务,可直接使用换装服务


注意事项:

输出图片会更改输入原图大小比例。

如果需要保持原图大小,请对结果图调用证件照抠图得到保证证件照裁剪一致,或选择调用证件照抠图换装

输入图片

换装结果(透明图)

接口鉴权

见:开放API对接文档

接口地址

【POST】https://open-api.gaoding.com/api/call/clothswap


请求头(request header)

字段

类型

是否必填

字段描述

app_id

string

应用ID,获取方式:应用列表 -> 应用详情 -> APP ID


请求体(request body)

字段

类型

是否必填

字段描述

url

string

二个必填一个

优先级:url>file_base64

输入图片url,要求为抠图接口输出的png图(带有人像alpha通道)

仅保留1个月,请及时转储

(无文件大小限制)

file_base64

string

原图的base64码

(最大支持3M文件)

result_type

string

结果返回类型:

枚举值:url,base64

默认url

cloth_classify

string

衣服分类四类:['boy','girl','man','woman']

cloth_id

string

服装ID(代表第几套衣服,

请先输入衣服分类,再输入分类下对应的服装ID,衣服见:衣服样式映射


请求体示例(url):

{
   "url":"https://matting-batch.dancf.com/cloths/20220825_143743_gaoding_imagematting_human.jpg",
   "cloth_classify": "woman",
   "cloth_id": 4
}

请求体示例(base64):

{ 
   "file_base64":"图片的base64编码",
   "cloth_classify": "woman",
   "cloth_id": 4
}



响应体(response body)

字段

类型

是否必存在

字段描述

result

string

url入参:结果图url,返回PNG格式,仅保留1个月,请及时转储

base64入参:返回图片base编码

响应示例1(模拟正常请求:url入参):

http_status:200

response body:

{
  "result": "https://matting-batch.dancf.com/product/api/12163bd3035cafcab0cce4a519bcc0f5-20220827120637512.png"
}


响应示例2(模拟正常请求:base64入参):

http_status:200

response body:

{
	"result": "图片的base64编码"
}


响应示例3(模拟参数非法请求):

http_status:400

response body:

{
    "code": -10003,
    "message": "InvalidArgsError"
}



错误码

HTTP状态码

业务错误码

含义

400

-10003

参数非法

400

-10024

通过指定的upload_address 上传的的时候失败

400

-10001

下载失败,可能是用户传的url非法,或者网络异常等原因导致下载失败

400

-10002

解码图片失败,可能是某些格式比较特殊的图片暂时还不支持,或者图片url下载下来根本不是图像数据

400

-10007

图片数据过大,无法处理

500

服务器错误

422

接口入参错误