证件照换装 #
地址:https://www.clipimg.com/api/idphoto/change_clothes
请求方式:POST
数据类型:JSON
响应类型:JSON
接口描述:此接口为证件照换装制作接口,调用不产生费用,结果保留1小时,1小时后自动删除制作结果图片,请及时保存。重复下载同一张照片不会重复扣费。
参数[Header]
参数名 | 说明 | 是否必选 | 类型 |
X-API-Key | 秘钥,点此获取 | 必选 | string |
Content-Type | 请求数据类型 | 必选 | application/json |
参数[Body]:
参数名 | 说明 | 是否必选 | 类型 |
img_name | 证件照图片名称 | 可选 | string |
file | Base64格式图片,不包含base64的头部数据 | img_name不传值时必选 | string |
clothes_id | 服装id | 必选 | int |
bg_color | 您所上传的证件照图片的背景色,16进制表示,eg:#02A7F0 | 必选 | string |
enc_color | 您所上传的证件照图片渐变色色值,可选,不传值时为纯色背景 | 可选 | string |
dpi | 返回的证件照分辨率,如果不设置该值,服务端会给出默认配置,一般返回300dpi的图片 | 可选 | int |
file_format | 文件生成类型,支持jpg,png。默认png | 可选,默认0,0表示png,1表示jpg | int |
返回:
参数 | 说明 | 示例 | 类型 |
code | 状态码 | 0 | int |
msg | 错误详情 | 成功 | string |
data | 结果 |
code取值
0 | 成功 |
400 | 参数错误 |
402 | 点数已用完 |
410 | 未检测到人脸 |
411 | 未检测到脖子 |
415 | 换装异常 |
data结构体
参数名称 | 说明 | 示例值 | 类型 |
download_url | 下载地址 | https://… | string |
preview_url | 预览地址 | https://… | string |
img_name | 无水印图片名称 | 9ad…._changeCloth | string |
preview_img_name | 预览图名称 | 9ad…._changeCloth_preview | string |
print_img_name | 排版照下载名称(注:在6证件照排版下载接口中使用) | 9ad…._changeCloth_print | string |
print_url | 排版照下载地址 | https://… | string |
preview_print_url | 排版照预览地址 | https://… | string |
preview_print_img_name | 排版照预览名称(注:在5证件照排版预览接口中使用) | 9ad…._changeCloth_print_preview | string |
证件照换装预览 #
地址:https://www.clipimg.com/api/idphoto/change_clothes/preview/预览图片名称
请求方式:GET
数据类型:application/x-www-form-urlencoded
响应类型:Image
计费:此接口不产生费用
参数:
参数名 | 说明 | 是否必选 | 类型 |
text | 给证件照增加自定义文字,url拼接字符串形式拼接, eg:https://www.clipimg.com/api/idphoto/change_clothes/preview/9ad…._changeCloth_preview?text=这是自定义文字 | 可选 | string |
返回:httpcode为200时返回图片流
httpcode为404时表示图片不存在
证件照换装下载 #
地址:https://www.clipimg.com/api/idphoto/change_clothes/download/无水印图片名称
请求方式:POST
数据类型:JSON
响应类型:Image
计费:此接口调用成功扣除API账户30点余额
参数[Header]
参数名 | 说明 | 是否必选 | 类型 |
X-API-Key | 秘钥 | 必选 | string |
Content-Type | 请求数据类型 | 必选 | application/json |
参数[Body]:
参数名 | 说明 | 是否必选 | 类型 |
text | 给证件照增加自定义文字 | 可选 | string |
返回:httpcode为200时返回图片流
httpcode为404时表示图片不存在
httpcode为402时表示点数已用完
换装列表 #
下载缩略图压缩包(1-16男装、17-32女装、33-48童装)