请求类型: HTTP/HTTPS
接口地址: http://apicall.id-photo-verify.com/api/sdk_cut_pic
请求方式: POST
请求数据类型:JSON
响应类型: JSON
接口状态: 启用
此接口是为了适配集成本地美颜SDK的项目(没有集成可以使用线上的美颜),返回一张透明底色带水印的图片,
可在本地美颜后请求对应的制作接口获取心仪的图片。推荐使用“制作并检测接口”获取最终图片。
调用此接口不会增加调用次数 结果返回透明底色带水印的图片URL及其名称,存储时间为 1 天 通过名字获取带水印图片不会增加已调用次数 (通过获取图片的api获取无水印图片或无水印已排版图片会增加 1 次调用次数) 同一个图片名称(包括单张和排版),如果需要再次获取,不会增加已调用次数
对应的app_key应用类型必须为本地美颜SDK适配 考虑到算法响应速度,图片最好不超过 6Mb SDK使用方式会在后续进行丰富
最新SDK下载地址:
参数名称 | 参数类型 | 是否可空 | 参数示例 | 参数说明 |
---|---|---|---|---|
file | string | 否 | app/123.jpg | 图片的base64格式(注意不包含base64的头部数据),或者图片在oss的key(见第十三个接口) |
spec_id | int | 否 | 361 | 已有的规格ID |
app_key | string | 否 | 已申请的app_key | |
process | string | 是 | image/resize,mxxx | 缩放规则(非特殊要求可无视) |
img_size | list | 是 | [926,617] | 制作结果宽高,若为空,则返回原比例未缩放图 |
ratios | list | 是 | [1,2,3,4,5] | 自定义证件照制作比率,详见第四个接口的“参数说明5” |
fair_level | dict | 是 | None | 左人像美颜级别,详细见下方说明 |
clothes | string | 是 | applet_boy1 | 正装模板名称(模板信息见换装接口) |
local_beauty | bool | 是 | False | 是否本地美颜,此参数为True时返回值beauty_intermediate_result字段才有意义 |
self_wm | int | 是 | 1 | 是否需要使用自定义水印,为1时表示需要使用自定义水印,需要使用自定义水印请联系我们 |
out_endpoint | string | 是 | https://oss-accelerate.aliyuncs.com | 控制返回链接的域名,见参数说明7 |
need_adjust_lighting | int | 是 | 1 | 是否需要做光照处理,1表示是,0表示否,默认否 |
enhanced_type | int | 是 | 3 | 图像增强控制参数,1表示不增强,2表示粗裁剪增强,3表示结果图增强, 默认不增强, 详细见参数说明6 |
pose_fix | int | 是 | 1 | 是否需要做姿态调整 0表示否(默认,头像摆正依据双眼水平) 1表示是(会矫正双眼水平和肩膀水平) |
origin_max_length | int | 是 | 原图缩放参数,传此参数时,原图最长边像素大于此值时会被等比例缩放到此值,此时接口耗时会相对较短,且更加稳定,推荐传此参数为1500;不传此参数时不缩放(默认不缩放). | 1500 |
fair_level说明(以下各项默认为0, 参数值类型须为整型):
{ "leyelarge": 1, # 左眼放大程度(0~5) "reyelarge": 1, # 右眼放大程度(0~5) "mouthlarge": 1, # 嘴巴缩小程度(0~5) "skinwhite": 1, # 皮肤美白程度(0~5) "skinsoft": 1, # 皮肤美肤程度(去皱纹、祛斑等)(0~5) "coseye": 1, # 美瞳程度(0~5) "facelift": 1 # 瘦脸程度(0~5) }
参数名称 | 类型 | 参数说明 |
---|---|---|
code | int | 状态码(200为正常请求,401为传入的规格id不存在) |
result | object | |
size | list | 图片大小(像素宽高比) |
source_file | str | 原图的云端存储路径(使用此路径作为此接口请求中的file将大大提高效率) |
img_wm_url | str | 带水印图片URL |
background_color | list | 对应规格的背景色,也可用于其他接口自定义背景色,详见第4接口参数说明4 |
beauty_intermediate_result | str | 美颜算法的中间结果,用于本地美颜 |
file_name | str | 文件名 |
# 同步请求 import requests, json, base64 def sdk_cut_pic(): url = "http://apicall.id-photo-verify.com/api/sdk_cut_pic" with open("test.png", 'rb') as f: pic = f.read() headers = {"Content-Type": "application/json"} data = { "spec_id": 391, # "img_size": [480, 640], # 有需求可自行设置 'local_beauty': True, # 本地美颜 "app_key": "your sdk app_key", "file": base64.b64encode(pic).decode(), } data_json = json.dumps(data) res = requests.post(url, headers=headers, data=data_json) print(res.status_code) print(res.text)
{ 'code': 200, 'result': { 'background_color': [{ 'color_name': 'blue', 'enc_color': 4427483, 'start_color': 4427483 }], 'beauty_intermediate_result': 'AQAAAAEAA...AAgD8=', 'file_name': 'sdkc9d594f3e833be4338789ec4dcd86275.png', 'img_wm_url': 'https://testleqi.oss-cn-shanghai.aliyuncs.com/al..._5', 'size': [295, 413], 'source_file': 'app/c9d594f3e833be4338789ec4dcd86275.jpg' } }