证件照API详细信息

温馨提示:

1,app_key为接口调用有效凭证,为确保安全,请将接口请求放置于自己的服务器上进行,并注意不要泄露。

2,当接口调用剩余次数在20000,5000,2000,1000,500,100次的时候,邮箱和注册的手机号会收到充值提醒。

3, 若返回的结果里存在result,则表内后续数据为result对象内的数据,即:result:{column1:...,...}

4, 为方便查阅,以下列出常见响应状态码,非200状态码的提示字段为“error”:

状态码描述解决方案
200请求成功 
400规格不存在(或者请求错误)输入已有规格(检查json格式)
401app_key不存在输入已申请的正确app_key
403身份验证不通过检查secret_key是否正确
412app类型不正确输入已申请的对应类型的app_key
417已达到最大调用次数购买调用次数
422缺少对应的参数检查上传的参数中缺少的对应项
506上传的base64数据不是图片 
507算法制作照片失败查看错误信息或联系开发人员

5, 部分接口的请求参数中的 file 可传图片的云端路径,目前为四、八、十、十一

 

 

一.证件照环境检测

基本信息:

请求类型: HTTP/HTTPS

接口地址: http://apicall.id-photo-verify.com/api/env_pic

请求方式: POST

数据类型: JSON

响应类型: JSON

接口状态: 启用

接口描述:

证件照环境检测,此接口多用于调用制作照片的接口之前,用于预检测

调用此接口不会增加已调用次数

对应的app_key应用类型必须为证件照环境检测

 

本接口环境检测采用设定阈值的方式,通过参数传过来的阈值,与算法检测出来的各项对应值比较,得到通过与否的结果(共7个检测项)。设定的阈值越大检测越不严格,越容易通过;阈值越小检测越严格,越不容易通过。

比如facepose检测项用户传过来阈值为 20,检测结果为 30,则该检测项不通过,如果想要放宽facepose此检测项的要求,可以调整阈值,将上传的阈值改为 40,则此检测项即为通过(用户看不到算法检测出来的各项对应值)。

用户可以根据自己需求不断调整传送的阈值,建议阈值依次顺序为40,40,35,20,50,50,60

 

请求格式:

参数名称是否必须类型描述
filetruestring图片的base64数据
app_keytruestring已申请的app_key
faceposetruestring/ number人脸是正对镜头(姿态) 阈值
eyegazetruestring/ number视线是否正常 阈值
eyeskewtruestring/ number眼睛是否歪斜(双眼连线不水平) 阈值
shoulderskewtruestring/ number肩膀是否水平正对镜头 阈值
darkillumtruestring/ number照片光照是否昏暗 阈值
unbalanceillumtruestring/ number人脸是否为阴阳脸 阈值
bfsimilaritytruestring/ number衣服和背景颜色是否相似 阈值

响应格式:

参数名称数据类型示例值描述
codenumber200状态码
msgnumberSUCCESS接口调用信息
total_resultnumber1检测结果汇总,各检测项中有一项未通过则为0,全部通过则为1
resultobject 各个参数的检查结果:1代表通过,0代表未通过
faceposenumber1人脸是正对镜头(姿态)
eyegazenumber1视线是否正常
eyeskewnumber1眼睛是否歪斜(双眼连线不水平)
shoulderskewnumber1肩膀是否水平正对镜头
darkillumnumber1照片光照是否昏暗
unbalanceillumnumber1人脸是否为阴阳脸
bfsimilaritynumber1衣服和背景颜色是否相似

 

示例:

返回数据示例:

 

 

二.制作证件照

基本信息:

请求类型: HTTP/HTTPS

接口地址: http://apicall.id-photo-verify.com/api/cut_pic

请求方式: POST

数据类型: JSON

响应类型: JSON

接口状态: 启用

接口描述:

制作证件照,推荐使用制作并检测接口

调用此接口不会增加已调用次数
结果返回带水印图片,无水印图片和无水印已排版图片名字(均为多种颜色)
带水印图片存储时间为 1 天,无水印图片存储时间为 7 天
通过名字获取带水印图片不会增加已调用次数
(通过获取图片的api获取无水印图片或无水印已排版图片会增加 1 次调用次数)

官网上对应的app_key应用类型必须为证件照制作

 

请求格式:

参数名称是否必须类型描述
filetruestring图片的base64数据
spec_idtruestring已有的规格ID
app_keytruestring已申请的app_key
is_fairfalseint是否美颜,0代表不美颜,1代表美颜,默认为美颜
fair_levelfalseint美颜等级,分为1,2,3,4,5等级,传其它数字默认为1级,只在is_fair为1时有效
originalfalseint程序会按照px = mm/25.4*original去设定照片的像素大小
face_width_minfalsestring/int人脸脸颊宽度(不包含耳朵)与照片宽度的最小比例
face_width_maxfalsestring/int人脸脸颊宽度(不包含耳朵)与照片宽度的最大比例

响应格式:

参数名称是否必须类型示例值描述
codetruenumber200状态码
resulttrueobject  
file_name_wmtruelist["56cf9c38d9a111e7a0a300163e06132ablue2_wm", "56cf9c39d9a111e7a0a300163e06132awhite2_wm", "56cf9c3ad9a111e7a0a300163e06132ared2_wm", "579b75b0d9a111e7a0a300163e06132ablue22_wm", "579b75b1d9a111e7a0a300163e06132agrey2_wm", "579b75b2d9a111e7a0a300163e06132ablue32_wm"]带水印图片名字,包括多种可选颜色
file_name_print_wmtruelist["56cf9c38d9a111e7a0a300163e06132ablue2_print_wm", "56cf9c39d9a111e7a0a300163e06132awhite2_print_wm", "56cf9c3ad9a111e7a0a300163e06132ared2_print_wm", "579b75b0d9a111e7a0a300163e06132ablue22_print_wm", "579b75b1d9a111e7a0a300163e06132agrey2_print_wm", "579b75b2d9a111e7a0a300163e06132ablue32_print_wm"]带水印排版图片名字,包括多种可选颜色
file_nametruelist["56cf9c38d9a111e7a0a300163e06132a68798blue2", "56cf9c39d9a111e7a0a300163e06132a65760white2", "56cf9c3ad9a111e7a0a300163e06132a03509red2", "579b75b0d9a111e7a0a300163e06132a71632blue22", "579b75b1d9a111e7a0a300163e06132a38271grey2", "579b75b2d9a111e7a0a300163e06132a81312blue32"]无水印图片名字,包括多种可选颜色
file_name_printtruelist["56cf9c38d9a111e7a0a300163e06132a68798blue2_print", "56cf9c39d9a111e7a0a300163e06132a65760white2_print", "56cf9c3ad9a111e7a0a300163e06132a03509red2_print", "579b75b0d9a111e7a0a300163e06132a71632blue22_print", "579b75b1d9a111e7a0a300163e06132a38271grey2_print", "579b75b2d9a111e7a0a300163e06132a81312blue32_print"]无水印排版图片名字,包括多种可选颜色
is_printtruenumber1有无排版
sizetruelist[295, 413]图片尺寸
size_printtruelist[1795, 1205]排版后图片尺寸
one_sheet_numtruenumber8排版的照片数量
img_wm_url_listtruelist["https://...",...],带水印单张照url列表
print_wm_url_listtruelist["https://...",...],带水印排版照url列表

注:名称列表和url列表内颜色顺序一一对应,url链接有效期为1个小时。

 

示例:

:

 

 

三.检测证件照

基本信息:

请求类型: HTTP/HTTPS

接口地址: http://apicall.id-photo-verify.com/api/check_pic

请求方式: POST

数据类型: JSON

响应类型: JSON

接口状态: 启用

接口描述:

检测证件照

调用此接口增加 1 次已调用次数

官网上对应的app_key应用类型必须为证件照检测

 

请求格式:

参数名称是否必须类型描述
filetruestring图片的base64数据
app_keytruestring已申请的app_key
spec_idtruestring已有的规格ID

 

响应格式(随着传入的spec_id的不同,响应数据的种类会有一些变化,未出现的字段可在下一个api内查找):

参数名称是否必须数据类型示例值描述
codetruenumber200状态码
check_resulttruenumber1检测结果汇总,各检测项中有一项未通过则为0,全部通过则为1
resulttrueobject 各个参数的检查结果:1代表通过,0代表未通过
background_colorfalsenumber1背景色
bg_shadowfalsenumber1背景阴影
chin_bottomfalsenumber1下巴距图像下边缘
clothes_similarfalsenumber1服装相似度
eye_spacefalsenumber1眼部距离
eyes_center_leftfalsenumber1双眼中心距图像左边缘
eyes_closefalsenumber1闭眼程度
eyes_naturefalsenumber1视线
eyes_space_bottomfalsenumber1双眼中心距图像下边缘
face_blurfalsenumber1模糊
face_centerfalsenumber1脸部居中
face_colorfalsenumber1脸部颜色
face_expressionfalsenumber1脸部表情
face_noisefalsenumber1脸部噪音
face_unbalancefalsenumber1阴阳脸
facial_posefalsenumber1脸部姿态
facial_shelterfalsenumber1脸部遮挡
facial_widthfalsenumber1脸部宽度
file_sizefalsenumber1文件大小
glassesfalsenumber1眼镜样式
glasses_glarefalsenumber1眼镜反光
hairline_topfalsenumber1头顶发际线
head_lengthfalsenumber1头部长度
head_occupyfalsenumber1头部占比
left_right_emptyfalsenumber1左右是否各空
mouse_naturefalsenumber1嘴巴自然
namefalsestring英语四六级考试规格名字
photo_formatfalsenumber1文件类型
ppifalsenumber1检测ppi
px_and_mmfalsenumber1像素和毫米大小
shoulder_equalfalsenumber1肩膀自然
sight_linefalsenumber1视线水平
spec_idfalsenumber23规格ID

示例:

返回数据示例:

 

四. 制作并检测证件照

基本信息:

请求类型: HTTP/HTTPS

接口地址: http://apicall.id-photo-verify.com/api/cut_check_pic

请求方式: POST

数据类型: JSON

响应类型: JSON

接口状态: 启用

 

接口描述:

制作并检测证件照

调用此接口,不会增加调用次数
此接口的程序会先制作证件照,然后对证件照进行检测,
结果返回带水印图片、无水印图片、无水印已排版图片名字(均为多种颜色)和检测的结果。
带水印图片存储时间为 1 天,无水印图片存储时间为 7 天
通过名字获取带水印图片不会增加已调用次数
(通过获取图片的api获取无水印图片或无水印已排版图片会增加 1 次调用次数)
请求参数中“必须”项为false的,可以不用传递。如果传递自定义值,将会使用用户自定义阈值处理照片,阈值越高越容易检测通过,不传的话默认使用已经定义好的阈值处理。

官网上对应的app_key应用类型必须为证件照检测与制作

 

请求格式:

参数名称是否必须类型描述示例值
filetruestring图片的base64格式或图片的云端路径 
spec_idtruestring已有的规格ID1
app_keytruestring已申请的app_key 
is_fairfalseint是否美颜,默认为美颜 
fair_levelfalseint美颜等级,分为1,2,3,4,5等级,另支持字典形式传输详见下方“参数说明3”,只在is_fair为1时有效1
head_length_max_pfalseint脸部长度max 
head_length_min_pfalseint脸部长度min 
head_occupy_max_pfalseint脸部占比max 
head_occupy_min_pfalseint脸部占比min 
eye_space_max_pfalseint双眼间距max 
eye_space_min_pfalseint双眼间距min 
hairline_top_max_pfalsestring发际线距边缘max300px
hairline_top_min_pfalsestring发际线距边缘min10px
eyes_center_left_max_pfalseint双眼中心距图像左边缘max 
eyes_center_left_min_pfalseint双眼中心距图像左边缘min 
eyes_space_bottom_max_pfalseint双眼距图像下边缘max414
eyes_space_bottom_min_pfalseint双眼距图像下边缘min324
shoulder_occupyfalseint肩部占比 
left_right_emptyfalseint左右各空 
facial_width_max_pfalseint脸部宽度max284
facial_width_min_pfalseint脸部宽度min180
width_pxfalseint像素宽度 
height_pxfalseint像素高度 
width_mmfalseint宽度毫米 
height_mmfalseint高度毫米 
file_size_maxfalseint文件大小最大值40960
file_size_minfalseint文件大小最小值20480
size_optionsfalsestring尺寸说明 
ppifalseint分辨率300
photo_formatfalsestring照片格式 
bit_depthfalseint位深度24
compressfalseint压缩比 
facial_posefalseint人脸姿态,是人脸姿态 yaw pitch roll的集中判断35
sight_linefalseint视线水平35
facial_shelterfalseint面部无遮挡(见下方说明) 
eyes_closefalseint闭眼50
eyes_naturefalseint视线自然50
mouse_naturefalseint嘴巴自然50
shoulder_equalfalseint肩膀等高50
face_unbalancefalseint阴阳脸50
glassesfalseint眼镜样式10
glasses_glarefalseint眼镜反光 
face_expressionfalseint脸部表情 
face_centerfalseint脸部居中,此参数为必检项,不受传参的影响1
face_colorfalseint色彩正常 
face_blurfalseint模糊程度50
face_noisefalseint噪声程度20
face_over_kbtfalseint过曝光60
bg_shadowfalseint背景阴影60
clothes_similarfalseint服装突出90
chin_bottom_min_pfalseint下巴距图像下边缘min 
shoulder_missedfalseint身体完整性,是肩部完整 头部完整 下半身悬空的集中判断60
face_width_minfalseint人脸脸颊宽度(不包含耳朵)与照片宽度的最小比例 
face_width_maxfalseint人脸脸颊宽度(不包含耳朵)与照片宽度的最大比例 
originalfalseint程序会按照px = mm/25.4*original去设定照片的像素大小 
missing_shoulderfalseint肩部完整30
incomplete_headfalseint头部完整60
lower_body_hangingfalseint下半身悬空30
headpose_yawfalseint人脸姿态(见下方说明)50
headpose_pitchfalseint人脸姿态(见下方说明)50
headpose_rollfalseint人脸姿态(见下方说明)50
face_too_darkfalseint照片过暗60
face_contrastfalseint对比度异常60
body_posturefalseint身体姿态 身子不正,自拍时斜向下,举手,手放脑后,抠鼻孔,托腮等60
hat_thresholdfalseint帽子检测20
bare_shoulderedfalseint光膀检测60
id_existfalseint手持证件照检测60
watermark_existfalseint照片有水印50
pn_mask_existfalseint照片有挂戴口罩90
background_colorfalselist自定义照片背景色,详见“参数说明4” 
ratiosfalselist自定义证件照制作比率,详见“参数说明5” 

参数说明1,headpose_yaw、headpose_pitch、headpose_roll参数说明示意:

参数说明2,facial_shelter参数说明:面部各部位遮挡置信度(眉毛、眼睛、鼻子、嘴巴、脸颊、耳朵 饰品遮挡) 当传了facial_shelter参数后, 此参数将会分别与七个遮挡检测项匹配,并且会返回具体每个项的匹配结果,七个参数分别是: 眉毛 eyebrow_occlusion 眼睛 eye_occlusion 鼻子 nose_occlusion 嘴巴 mouth_occlusion 脸颊 cheek_occlusion 耳朵 ear_occlusion 饰品遮挡 decoration_occlusion


参数说明3,fair_level对应的值可以是字典的形式(注:不支持全部传0的情况),如: "fair_level": {"leyelarge":0.1, #左眼放大程度 "reyelarge":0.1, #右眼放大程度 "mouthlarge":0.1, #嘴巴缩小程度 "skinwhite":1, #皮肤美白程度 "skinsoft":0.1, #皮肤光滑度 "coseye":0.1, #美瞳程度 "facelift":0.1 #瘦脸程度 }, # 美颜等级,有效范围在0到1,数值越大,则美颜程度越高


参数说明4,background_color须为list类型,最多能够设置6种背景色,如: [{"start_color": 16777215,"color_name": "white", "enc_color": 16777215}, {"start_color": 4427483, "color_name": "blue", "enc_color": 4427483}] start_color 为照片上部色值,对应的是RGB色值的十进制形式, color_name 为颜色名称,str类型,制作成功时,此字段对应的值会出现在图片名称里, enc_color 为照片下部色值,如与上部色值一致,则背景为纯色,如不一致则为渐变色。


参数说明5,ratios为照片制作比率参数,须为list类型,取值范围均在0到1之间,每个参数均不可省略,如没有特定要求,可将最小值和最大值范围设宽一些;参数设定不合理,将直接影响制作的成功率,如: [0.5, 0.7, 0.5, 0.72, 0.05, 0.15, 0.35, 0.75] 第一个参数为,head_h/pic_h 的最小值, 第二个参数为,head_h/pic_h 的最大值, 第三个参数为,eye_h/pic_h 的最小值, 第四个参数为,eye_h/pic_h 的最大值, 第五个参数为,top_h/pic_h 的最小值, 第六个参数为,top_h/pic_h 的最大值, 第七个参数为,face_w/pic_w的最小值, 第八个参数为,face/pic_w的最大值。

 

 

响应格式(随着传入的spec_id的不同,响应数据的种类会有一些变化):

参数名称数据类型示例值描述
codenumber200状态码
resultobject  
source_filestrapp/5f6caba546c5ec889feffa88e4fb6dc1.jpg原图的云端存储路径(使用此路径作为此接口请求中的file将大大提高效率)
checkobject1检测结果汇总,各检测项中有一项未通过则为0,全部通过则为1
check_resultobject 各个参数的检查结果:1代表通过,0代表未通过
background_colornumber1背景色
bg_shadownumber1背景阴影
chin_bottomnumber1下巴距图像下边缘
clothes_similarnumber1服装相似度
eye_spacenumber1眼部距离
eyes_center_leftnumber1双眼中心距图像左边缘
eyes_closenumber1闭眼程度
eyes_naturenumber1视线
eyes_space_bottomnumber1双眼中心距图像下边缘
face_blurnumber1模糊
face_centernumber1脸部居中
face_colornumber1脸部颜色
face_expressionnumber1脸部表情
face_noisenumber1脸部噪音
face_unbalancenumber1阴阳脸
facial_posenumber1脸部姿态
facial_shelternumber1脸部遮挡
facial_widthnumber1脸部宽度
file_sizenumber1文件大小
glassesnumber1眼镜样式
glasses_glarenumber1眼镜反光
hairline_topnumber1头顶发际线
head_lengthnumber1头部长度
shoulder_missednumber1肩膀完整性(包括肩膀、头部和胸部完整性)
shoulder_equalnumber1肩膀等高
headpose_pitchnumber1头部姿态
headpose_rollnumber1头部姿态
headpose_yawnumber1头部姿态
eyebrow_occlusionnumber1眉毛遮挡
eye_occlusionnumber1眼睛遮挡
nose_occlusionnumber1鼻子遮挡
mouth_occlusionnumber1嘴巴遮挡
cheek_occlusionnumber1脸颊遮挡
ear_occlusionnumber1耳朵遮挡
decoration_occlusionnumber1饰品遮挡
missing_shouldernumber1肩膀完整性
incomplete_headnumber1头部完整性
lower_body_hangingnumber1下半身悬空
face_too_darknumber1照片过暗
face_over_kbtnumber1过曝光
face_contrastnumber1对比度异常
body_posturenumber1身体姿态 身子不正,自拍时斜向下,举手,手放脑后,抠鼻孔,托腮等
hat_detectionnumber1帽子检测
bare_shoulderednumber1光膀检测
id_existnumber1手持证件照检测
watermark_existnumber1照片有水印
ppinumber1分辨率
namestring图片的规格名称图片的规格名称
file_name_wmlist["56cf9c38d9a111e7a0a300163e06132ablue3_wm", "56cf9c39d9a111e7a0a300163e06132awhite3_wm", "56cf9c3ad9a111e7a0a300163e06132ared3_wm", "579b75b0d9a111e7a0a300163e06132ablue23_wm", "579b75b1d9a111e7a0a300163e06132agrey3_wm", "579b75b2d9a111e7a0a300163e06132ablue33_wm"]带水印图片名字,包括多种可选颜色
file_name_print_wmlist["56cf9c38d9a111e7a0a300163e06132ablue3_print_wm", "56cf9c39d9a111e7a0a300163e06132awhite3_print_wm", "56cf9c3ad9a111e7a0a300163e06132ared3_print_wm", "579b75b0d9a111e7a0a300163e06132ablue23_print_wm", "579b75b1d9a111e7a0a300163e06132agrey3_print_wm", "579b75b2d9a111e7a0a300163e06132ablue33_print_wm"]带水印排版图片名字,包括多种可选颜色
file_namelist["56cf9c38d9a111e7a0a300163e06132a68798blue3", "56cf9c39d9a111e7a0a300163e06132a65760white3", "56cf9c3ad9a111e7a0a300163e06132a03509red3", "579b75b0d9a111e7a0a300163e06132a71632blue23", "579b75b1d9a111e7a0a300163e06132a38271grey3", "579b75b2d9a111e7a0a300163e06132a81312blue33"]无水印图片名字,包括多种可选颜色
file_name_printlist["56cf9c38d9a111e7a0a300163e06132a68798blue3_print", "56cf9c39d9a111e7a0a300163e06132a65760white3_print", "56cf9c3ad9a111e7a0a300163e06132a03509red3_print", "579b75b0d9a111e7a0a300163e06132a71632blue23_print", "579b75b1d9a111e7a0a300163e06132a38271grey3_print", "579b75b2d9a111e7a0a300163e06132a81312blue33_print"]无水印排版图片名字,包括多种可选颜色
is_printnumber1有无排版
sizelist[295, 413]图片尺寸
size_printlist[1795, 1205]排版后图片尺寸
one_sheet_numnumber8排版的照片数量
not_check_resultlist[{"check_param": "face_blur", "param_message": "脸部模糊"},...]检测未通过参数
img_wm_url_listlist["https://...",...],带水印单张照url列表
print_wm_url_listlist["https://...",...],带水印排版照url列表

注:名称列表和url列表内颜色顺序一一对应,url链接有效期为1个小时。

 

示例:

返回数据示例:

 

五. 获取带水印图片

基本信息:

请求类型: HTTP/HTTPS

接口地址: http://apicall.id-photo-verify.com/api/take_pic_wm/<file_name>

请求方式: GET

响应类型: Image

接口状态: 启用

 

接口描述:

获取带水印图片

调用此接口不会增加调用次数

示例:

 

返回数据示例:

 

六. 获取无水印图片

基本信息:

请求类型: HTTP/HTTPS

接口地址: http://apicall.id-photo-verify.com/api/take_cut_pic

请求方式: POST

数据类型: JSON

响应类型: Image

接口状态: 启用

 

接口描述:

获取无水印图片

调用此接口会增加已调用次数,无换装证件照扣一次,换装证件照扣三次
同一文件名再次获取,不会增加已调用次数

对应的app_key必须和制作时所用的app_key一致

 

请求格式:

参数名称是否必须类型描述
file_nameTRUEstring需要获取图片的名字
app_keyTRUEstring已申请的app_key

 

示例:

 

七. 同时获取无水印单张和排版图片

基本信息:

请求类型: HTTP/HTTPS

接口地址: http://apicall.id-photo-verify.com/api/take_cut_pic_v2

请求方式: POST

数据类型: JSON

响应类型: JSON

接口状态: 启用

 

接口描述:

同时获取无水印单张和排版图片

调用此接口会增加已调用次数,无换装证件照扣一次,换装证件照扣三次
同一文件名再次获取,不会增加已调用次数

对应的app_key必须和制作时所用的app_key一致

 

请求格式:

参数名称是否必须类型描述
file_nameTRUEstring获取的无水印单张图片的名字
app_keyTRUEstring已申请的app_key

 

示例:

 

返回数据示例:

 

八. 剪裁换正装

基本信息:

请求类型: HTTP/HTTPS

接口地址: http://apicall.id-photo-verify.com/api/cut_change_clothes

请求方式: POST

数据类型: JSON

响应类型: JSON

接口状态: 启用

 

接口描述:

对原图按证件照规格裁剪,并为其换上正装。

调用此接口不扣使用次数,通过此接口的返文件名去获取无水印图片,扣3次使用次数。
同一个图片名称(包括单张和排版),如果需要再次获取,不会增加已调用次数

官网上对应的app_key应用类型必须为剪裁换正装

 

请求格式:

参数名称是否必须类型描述
fileFALSEstring图片的base64格式或图片的云端路径
app_keyTRUEstring已申请的app_key
spec_idTRUEint规格id
width_pxFALSEint自定义像素宽度值
height_pxFALSEint自定义像素高度值
clothesTRUEstring正装模板名称(模板信息见下表)
fair_levelFALSEdict美颜级别(默认为0,代表不美颜,级别1-5,美颜程度依次增强)
origin_pic_nameFALSEstring初始图片名称,同一张照片进行不同换装时,请传入此参数
background_colorFALSElist自定义照片背景色,详见第四个接口“制作并检测证件照”下方的“参数说明4”
ratiosFALSElist自定义证件照制作比率,详见第四个接口的“参数说明5”

模板信息:

正装模板名称模板预览图url模板预览图片描述
applet_boy1https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_boy1%403x.pngimg男装模板1
applet_boy2https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_boy2%403x.pngimg男装模板2
applet_boy3https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_boy3%403x.pngimg男装模板3
applet_boy4https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_boy4%403x.pngimg男装模板4
applet_boy5https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_boy5%403x.pngimg男装模板5
applet_boy6https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_boy6%403x.pngimg男装模板6
applet_boy7https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_boy7%403x.pngimg男装模板7
applet_boy8https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_boy8%403x.pngimg男装模板8
applet_boy9https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_boy9%403x.pngimg男装模板9
applet_boy10https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_boy10%403x.pngimg男装模板10
applet_boy11https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_boy11%403x.pngimg男装模板11
applet_boy12https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_boy12%403x.pngimg男装模板12
applet_boy13https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_boy13%403x.pngimg男装模板13
applet_boy14https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_boy14%403x.pngimg男装模板14
applet_boy15https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_boy15%403x.pngimg男装模板15
applet_boy16https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_boy16%403x.pngimg男装模板16
applet_girl1https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_girl1%403x.pngimg女装模板1
applet_girl2https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_girl2%403x.pngimg女装模板2
applet_girl3https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_girl3%403x.pngimg女装模板3
applet_girl4https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_girl4%403x.pngimg女装模板4
applet_girl5https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_girl5%403x.pngimg女装模板5
applet_girl6https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_girl6%403x.pngimg女装模板6
applet_girl7https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_girl7%403x.pngimg女装模板7
applet_girl8https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_girl8%403x.pngimg女装模板8
applet_girl9https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_girl9%403x.pngimg女装模板9
applet_girl10https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_girl10%403x.pngimg女装模板10
applet_girl11https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_girl11%403x.pngimg女装模板11
applet_girl12https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_girl12%403x.pngimg女装模板12
applet_girl13https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_girl13%403x.pngimg女装模板13
applet_girl14https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_girl14%403x.pngimg女装模板14
applet_girl15https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_girl15%403x.pngimg女装模板15
applet_kid1https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_kid1%403x.pngimg童装模板1
applet_kid2https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_kid2%403x.pngimg童装模板2
applet_kid3https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_kid3%403x.pngimg童装模板3
applet_kid4https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_kid4%403x.pngimg童装模板4
applet_kid5https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_kid5%403x.pngimg童装模板5
applet_kid6https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_kid6%403x.pngimg童装模板6
applet_kid7https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_kid7%403x.pngimg童装模板7
applet_kid8https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_kid8%403x.pngimg童装模板8
applet_kid9https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_kid9%403x.pngimg童装模板9
applet_kid10https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_kid10%403x.pngimg童装模板10
applet_kid11https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_kid11%403x.pngimg童装模板11
applet_kid12https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_kid12%403x.pngimg童装模板12
applet_kid13https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_kid13%403x.pngimg童装模板13
applet_kid14https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_kid14%403x.pngimg童装模板14
applet_kid15https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_kid15%403x.pngimg童装模板15
applet_kid16https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_kid16%403x.pngimg童装模板16
applet_kid17https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_kid17%403x.pngimg童装模板17
applet_kid18https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_kid18%403x.pngimg童装模板18
applet_kid19https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_kid19%403x.pngimg童装模板19
applet_kid20https://leqi-public.oss-cn-shanghai.aliyuncs.com/wechat_applet/clothes/applet_kid20%403x.pngimg童装模板20

 

响应格式:

参数名参数类型参数说明
codeint状态码
final_pic_namelist无水印图片名称列表(同‘带水印图片url列表’顺序),调获取无水印图片接口,进行获取。
origin_pic_namestr原始图片名
print_pic_namelist无水印排版图片名称列表(同‘带水印图片url列表’顺序),调获取无水印图片接口,进行获取。
print_wm_pic_urllist带水印排版图片url列表(同‘带水印图片url列表’顺序)
wm_pic_urllist带水印图片url列表
errorstr错误信息提示
one_sheet_numint排版的照片数量
source_filestr原图的云端存储路径(使用此路径作为此接口请求中的file将大大提高效率)

 

示例:

返回数据示例:

 

九. 规格详情

基本信息:

请求类型: HTTP/HTTPS

接口地址: http://apicall.id-photo-verify.com/api/get_specs/<spec_id>

请求方式: GET

数据类型: spec_id 需为int类型

响应类型: JSON

接口状态: 启用

 

接口描述:

传入spec_id,获取对应的规格详情。

调用此接口不会增加调用次数

响应格式:

参数名参数类型参数说明
codeint状态码(200为正常请求,401为传入的规格id不存在)
spec_idint规格id
spec_namestr规格名称
width_pxint规格宽度像素
height_pxint规格高度像素
width_mmint规格对应的宽度毫米尺寸
height_mmint规格对应的高度毫米尺寸
file_size_maxint规格文件大小最大值(单位:b),为null则表示没有限制
file_size_minint规格文件大小最小值(单位:b),为null则表示没有限制
ppiint规格分辨率
background_colorstr规格背景色信息
is_printint是否有排版照(1,表示有;0,表示没有)
errorstr错误信息提示

示例:

 

返回数据示例:

 

 

十. 结婚照制作

基本信息:

请求类型: HTTP/HTTPS

接口地址: http://apicall.id-photo-verify.com/api/cut_wedding

请求方式: POST

数据类型: JSON

响应类型: JSON

接口状态: 启用

 

接口描述:

此方法是对双人照片进行换底裁剪,其中裁剪结果图为一张宽高比为3:2的图片,图片的大小会影响响应的时间

调用此接口不会增加调用次数
结果返回带水印图片,无水印图片和无水印已排版图片名字(均为多种颜色)
带水印图片存储时间为 1 天,无水印图片存储时间为 7 天
通过名字获取带水印图片不会增加已调用次数
(通过获取图片的api获取无水印图片或无水印已排版图片会增加 2 次调用次数)
同一个图片名称(包括单张和排版),如果需要再次获取,不会增加已调用次数

对应的app_key应用类型必须为结婚照制作 为保证图片质量,请上传的图片尽量遵循“男右女左”的顺序、且不戴首饰 考虑到算法响应速度,图片最好不超过 6Mb

 

请求格式:

参数名称参数类型是否可空参数示例参数说明
filestringapp/123.jpg图片的base64格式或图片的云端路径
app_keystring 已申请的app_key
processstringimage/resize,mxxx缩放规则
img_sizelist[926,617]制作结果宽高,宽高比例必须为3:2,若为空,则返回宽高比为3:2的未缩放图
fair_level_rightdictNone右人像美颜级别,详细见下方说明
fair_level_leftdictNone左人像美颜级别,详细见下方说明
need_beauty_bufferboolTrue是否需要美颜中间参数,默认为False,在客户端本地美颜时,需要此参数为True,且img_size字段将失效
use_cacheboolTrue是否需要使用缓存,默认为True

 

fair_level说明(以下各项默认为0):

 

响应格式(详见下方返回示例):

参数名参数类型参数说明
codeint状态码(200为正常请求,401为传入的规格id不存在)
resultobject 
file_namestr无水印图片名称
file_name_wmstr带水印图片名称
img_wm_urlstr带水印图片URL
source_filestr原图的云端存储路径(使用此路径作为此接口请求中的file将大大提高效率)
sizelist图片尺寸(只有传递img_size才会有)
beauty_bufferobject 
leftstrbase64编码后的左脸的美颜中间结果
rightstrbase64编码后的左脸的美颜中间结果

示例:

 

返回示例:

 

十一. 本地美颜SDK

基本信息:

请求类型: 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下载地址:

Android_v1002.zip

iOS_v1002.zip

 

请求格式:

参数名称参数类型是否可空参数示例参数说明
filestringapp/123.jpg图片的base64格式或图片的云端路径
spec_idint361已有的规格ID
app_keystring 已申请的app_key
processstringimage/resize,mxxx缩放规则(非特殊要求可无视)
img_sizelist[926,617]制作结果宽高,若为空,则返回原比例未缩放图
ratioslist[1,2,3,4,5]自定义证件照制作比率,详见第四个接口的“参数说明5”
fair_leveldictNone左人像美颜级别,详细见下方说明
is_changeboolTrue是否需要换装
clothesstringapplet_boy1正装模板名称(模板信息见换装接口),若要换装is_change必须设定为True
local_beautyboolFalse是否本地美颜,此参数为True时返回值beauty_intermediate_result字段才有意义

 

fair_level说明(以下各项默认为0):

注:因为历史遗留的原因,制作并检测或换装接口的 fair_level 都需要除以5后再传递

 

响应格式(详见下方返回示例):

参数名参数类型参数说明
codeint状态码(200为正常请求,401为传入的规格id不存在)
resultobject 
sizelist图片大小(像素宽高比)
source_filestr原图的云端存储路径(使用此路径作为此接口请求中的file将大大提高效率)
img_wm_urlstr带水印图片URL
background_colorlist对应规格的背景色,也可用于其他接口自定义背景色,详见第4接口参数说明4
beauty_intermediate_resultstr美颜算法的中间结果,用于本地美颜

示例:

 

返回示例:

 

十二. 获取线上美颜版本

基本信息:

请求类型: HTTP/HTTPS

接口地址: http://apicall.id-photo-verify.com/api/get_beauty_version

请求方式: GET

响应类型: JSON

接口状态: 启用

 

接口描述:

此接口是为了配合本地美颜SDK接口,用于获取线上美颜版本号。

调用此接口不会增加调用次数

响应格式:

参数名参数类型参数说明
codeint状态码(200为正常请求)
beauty_versionstr 
errorstr错误信息提示

 

十三. 获取OSS直传凭证

基本信息:

请求类型: HTTP/HTTPS

接口地址: http://apicall.id-photo-verify.com/api/get_upload_policy

请求方式: GET/POST

响应类型: JSON

接口状态: 启用

 

接口描述:

为了降低服务器压力,提高接口响应效率,故新增获取OSS直传凭证的接口。

调用此接口不会增加调用次数
图片保存时间为 1 天

接口说明:

img

服务端签名后直传的原理如下:

  1. 用户发送上传Policy请求到应用服务器。
  2. 应用服务器返回上传Policy和签名给用户。
  3. 用户直接上传数据到OSS。
  4. 用户可用上传的文件路径(即key)访问支持此格式的接口

通过此方式访问证件照制作接口,将提高算法的响应速度,如何保证双方正常通信请查看下方“响应格式”

 

请求格式:

参数名参数类型是否可空参数示例参数说明
file_namestrtest.png带后缀的图片名称,目的就是提取图片格式,必填

 

响应格式:

参数名参数类型参数说明
codeint状态码(200为正常请求)
resultobject 
OSSAccessKeyIdstr上传凭证之一
dirstr上传图片前缀(不要改动)
keystr文件名,按此格式上传即可
expireint过期时间(时间戳)
hoststr请求网址
policystr前面之一
signaturestr签名,上传凭证之一
filefile上传的文件,二进制形式

 

返回示例:

 

使用方法(ajax):

注意点:以上代码仅为示例代码,不代表推荐使用代码。请根据具体业务要求更改或重新构建代码。

 

十四. 全身(半身)换装

基本信息:

请求类型: HTTP/HTTPS

接口地址: http://apicall.id-photo-verify.com/api/whole_body_change

请求方式: POST

数据类型: JSON

响应类型: JSON

接口状态: 启用

 

接口描述:

此接口传入一张单人照(人物头部完整就行,不需要传全身照!!!不需要传全身照!!!不需要传全身照!!!),选择服装模板后返回对应的透明底换装图片,可参考剪裁并换装接口。目前主要用于毕业照的换装。

 

调用此接口不会增加调用次数
结果返回透明底色带水印的图片URL及其名称,存储时间为 1 天
通过名字获取带水印图片不会增加已调用次数
(通过获取图片的api获取无水印图片或无水印已排版图片会增加 1 次调用次数)
同一个图片名称(包括单张和排版),如果需要再次获取,不会增加已调用次数

对应的app_key应用类型必须为全身(半身)换装

考虑到响应速度,图片请用上方获取OSS直传凭证上传文件后使用图片的云端路径访问

 

效果展示(灵魂画师):

 

请求格式:

参数名称参数类型是否可空参数示例参数说明
filestringapp/123.jpg图片文件oss存储路径名称
clothes_idint1已有的服装ID
app_keystring 已申请的app_key
processstringimage/resize,mxxx缩放规则(非特殊要求可无视)
img_sizelist[926,617]制作结果宽高(非特殊要求可无视)
need_resizeboolFalse是否需要缩放,img_size只是确定比例,但是不会缩放(默认不缩放)
ratioslist[1,2,3,4,5]自定义证件照制作比率,详见第四个接口的“参数说明5”
fair_leveldictNone人像美颜级别,详细见下方说明
hat_idboolTrue已有帽子ID,若不需要帽子可不传
hat_paramsdictNone帽子的参数,为字典格式,详见下方说明(非必要情况无需传递此参数)

 

fair_level说明(以下各项默认为0):

 

帽子hat_params参数说明:

hat_params字段为字典格式,当非空时,其有必须要有如下四个点的坐标

帽子坐标

 

全身服装模板:

clothes_id效果图备注
1毕业照模板1

 

帽子模板:

hat_id效果图备注
1学士帽1

 

 

响应格式(详见下方返回示例):

参数名参数类型参数说明
codeint状态码(200为正常请求,401为传入的规格id不存在)
resultobject 
sizelist图片大小(像素宽高比)
source_filestr原图的云端存储路径(使用此路径作为此接口请求中的file将大大提高效率)
img_wm_urlstr带水印图片URL
file_namelist无水印图片名称

示例:

 

返回示例:

 

十五. 半身照/全身照抠图

基本信息:

请求类型: HTTP/HTTPS

接口地址: http://apicall.id-photo-verify.com/api/cutout_pic

请求方式: POST

数据类型: JSON

响应类型: JSON

接口状态: 启用

 

接口描述:

此接口可以进行完整的人体抠图,也可以通过设置裁剪参数来对人体进行粗略的裁剪,多人脸也能正常抠图,只是只扣算法选中的第一张人脸。结果返回扣好图后的透明底图片。

 

调用此接口不会增加调用次数
结果返回透明底色带水印的图片URL及其名称,存储时间为 1 天
通过名字获取带水印图片不会增加已调用次数
(通过获取图片的api获取无水印图片或无水印已排版图片会增加 1 次调用次数)
同一个图片名称(包括单张和排版),如果需要再次获取,不会增加已调用次数

对应的app_key应用类型必须为半身照/全身照抠图

考虑到响应速度,图片请用上方获取OSS直传凭证上传文件后使用图片的云端路径访问

 

请求格式:

参数名称参数类型是否可空参数示例参数说明
filestringapp/123.jpg图片文件oss存储路径名称
app_keystring 已申请的app_key
img_sizelist[926,617]制作结果宽高(非特殊要求不要传)
need_resizeboolFalse是否需要缩放,img_size只是确定比例,但是不会缩放(默认不缩放,非特殊要求不要传)
head_heightlist[0.25, 0.50]头高 与 照片高度的比例范围(非特殊要求不要传)
headtop_marginlist[0.05, 0.10]头顶部到照片上边框距离与照片高度的比例范围(非特殊要求不要传)

注:若想自定义裁剪,img_size、need_resize、head_height、headtop_margin四个参数必填,具体可咨询技术人员

 

响应格式(详见下方返回示例):

参数名参数类型参数说明
codeint状态码(200为正常请求,401为传入的规格id不存在)
resultobject 
source_filestr原图的云端存储路径(使用此路径作为此接口请求中的file将大大提高效率)
img_wm_urlstr带水印图片URL
file_namelist无水印图片名称

示例:

 

返回示例:

 

 

更新信息:

2020年06月10 1,新增全身(半身)换装接口; 2, 新增半身照/全身照抠图接口。

2020年06月04 1,剪裁换正装接口file可为图片存储于云端的路径,并增加缓存功能。

2020年06月02 1,新增获取OSS直传凭证接口。 2, 制作并检查证件照、结婚照制作、本地美颜SDK接口新增返回参数source_file,即源图片存储于云端的路径,使用方法请查看下一条说明。 3, 制作并检查证件照、结婚照制作、本地美颜SDK接口的上传参数file可为图片存储于云端的路径。 4 , 制作并检查证件照、结婚照制作、本地美颜SDK接口新增缓存功能,同一张图片(无论是base64还是云端路径)的多次访问的响应速度大大提升。

2020年05月28 1,新增本地美颜SDK适配接口。 2, 剪裁换正装接口请求参数fair_level类型换为dict。 3 , 换装模板新增 男装模板14~16,女装模板13~15,童装模板19、20。

2020年05月22 1,新增结婚照制作接口。 2, 优化api文档,下载api文档改为markdown文件。

2020年05月12 1,制作并检测接口,新增“pn_mask_exist”参数。

2020年04月13日 1,换装接口,请求参数新增“ratios”字段 2,增加了换装模板

2019年12月19日 1,换装接口,返回值新增“one_sheet_num”字段

2019年12月16日 1,换装接口,新增自定义背景色功能

2019年12月9日 1,新增了一些正装模板

2019年11月19日 1,“制作并检测证件照”接口新增background_color,ratios参数。

2019年11月13日 1,新增了一些正装模板

2019年11月4日 1,新增“规格详情”接口

2019年10月22日 1,“制作并检测证件照”新增检测项:照片存在水印,检测项参数“watermark_exist”

2019年10月21日 1,“裁剪换正装”接口,请求参数支持自定义宽高像素。

2019年9月30日更新内容: 1,此次更新内容为:新增“裁剪换正装”接口。

2019年9月25日更新内容: 1,“制作证件照”和“制作并检测证件照”接口返回内容中,新增字段“img_wm_url_list”,表示单张带水印照片的url列表,新增字段“print_wm_url_list”,表示带水印排版照的url列表。

2019年9月6日更新内容: 1,“制作证件照”和“制作并检测证件照”接口返回内容中,新增字段“one_sheet_num”,表示排版的照片张数。 2,“制作并检测证件照”接口返回内容中,新增字段“not_check_result”,表示检测未通过项的参数。

2019年7月1日更新内容: 1,此次更新为新加光膀检测,参数:bare_shouldered。

2019年6月25日更新内容: 1,此次更新参数“fair_lever”的说明,支持以字典形式传输。

2019年5月10日更新内容: 1,“制作并检测证件照”接口的检测算法更新,新加检测项参数:missing_shoulder、incomplete_head、lower_body_hanging、headpose_yaw、headpose_pitch、headpose_roll、face_too_dark、face_contrast。 2,“制作并检测证件照”接口参数“facial_shelter”更新,面部遮挡检测更加全面。 3,“证件照制作”和“制作并检测证件照”接口中返回的排版照间距进行了优化,方便手动裁切。