欢迎使用电子照助手
www.dianzizhao.com API
Hi，开发者您好，欢迎使用电子照助手的API。以下内容，是您接入服务的一些基本介绍，希望您能够在这里找到适合您业务的AI技术能力，感谢您的使用！
快速开始
获取API Key
* 新用户免费赠送1000点
示例下载
以下demo中包含了Java、PHP、Python、.Net/C#语言的调用示例，帮助您快速接入到您的系统中。
注：
1.Http状态码401时表示您的APIKEY没有通过API网关验证，请检查您的APIKEY是否有效
2.文件大小不超过10mb
购买API账号点数
调用部分接口需消耗账户api点数，api点数需要充值购买， 充值入口
1. 证件照预览
地址：https://www.dianzizhao.com/api/open/idphoto?type=preview
请求方式：POST
数据类型：application/x-www-form-urlencoded
响应类型：Json
计费：此接口不产生费用
参数：
| 参数名 | 说明 | 是否必选 | 类型 |
| croppedImage |
预处理图片，Base64字符串格式。 您可以在您的程序中提前将照片进行裁剪、旋转、压缩等处理。 |
必填 | string |
| width | 证件照图片宽度，单位为像素（px） | 必填 | string |
| height | 证件照图片高，单位为像素（px） | 必填 | string |
| resolution |
证件照图片分辨率，单位为DPI。
默认值为300，社保卡/退役军人优待证/身份证等请使用350分辨率或更高 |
可选 | string |
| filetype | 文件格式，可选项为jpg/png，默认为jpg。 | 可选 | string |
| sizemin | 证件照文件压缩的最小KB，默认值为10。 | 可选 | string |
| sizemax | 证件照文件压缩的最大KB，默认值为1024。 | 可选 | string |
| sizeunit | 证件照文件压缩的单位，默认值为KB。 | 可选 | string |
| color |
证件照底色（背景颜色）。
1、当filetype为png时，color值为null则返回透明背景证件照。 2、当filetype为jpg时，color值为null或空则返回原图背景（不更换背景色） 3、标准证件照背景色：white（白色）/red（红色）/darkred（深红色）/blue（标准蓝色）/tint（浅蓝色）/darkblue（深蓝色）/gray（灰色） 4、渐变背景色（垂直方向）：格式为“起始色值,结束色值”，例如： 蓝白渐变：#3492C4,#ffffff 灰白渐变：#9c9c9c,#f9f9f9 浅蓝渐变：#6cb8f3,#d5eeff 红白渐变：#c90507,#f8e1e1 5、渐变背景色（圆心径向）：格式为“起始色值~结束色值” 6、自定义纯色：格式为“色值”，例如：#c41f34 更多色值您可参考：https://www.dianzizhao.com/dp |
可选 | string |
| advanced | 证件照AI高清修复，可大幅度提高照片清晰度并修复低质量照片 | 可选 | bool |
| appendtext | 附加文字，不超过20个字符（中文按2字符计算），文字将出现在照片底部 | 可选 | string |
| headtop | 证件照头顶留白距离，即人像头顶距离上边距的像素距离，与headtoprange参数配合使用，用于限定照片中头顶留白距离。 | 可选 | string |
| headtoprange |
证件照头顶留白距离的浮动范围，与headtop参数配合使用。 例如，您要限定照片头顶留白标准距离为20像素，并且头顶留白距离在10~30像素之间均可，您可以设置headtop=20，headtoprange=10。 |
可选 | string |
| headmax |
证件照中头部高度最大占比，计算方式为：证件照高度/头部高度。 例如，某证件照要求头部高度最大为300像素，证件照高度为480像素，则headmax=480/300=1.6。 |
可选 | string |
| headmin |
证件照中头部高度最小占比，计算方式为：证件照高度/头部高度。 例如，某证件照要求头部高度最小为200像素，证件照高度为480像素，则headmax=480/300=2.4。 |
可选 | string |
| quality |
是否对证件照质量进行检查，检查项包括照片过暗、照片模糊、是否为卡通人脸、是否过度美颜、多张人脸、人脸不完整
可选值：true/false |
可选 | bool |
| rotate | 图片旋转角度，顺时针为正整数，逆时针为负整数 | 可选 | int |
| autotone | 美颜——自动色调，可优化照片偏色，增强色彩真实感 | 可选 | bool |
| autodefreckle | 美颜——自动祛斑，可自动识别并去除脸部斑、痘、痣 | 可选 | bool |
| face_white | 美颜——肤色美白，设定值范围：0~100 | 可选 | int |
| face_soften | 美颜——磨皮，可增加皮肤光滑度，设定值范围：0~100 | 可选 | int |
| face_thin | 美颜——瘦脸，设定值范围：0~100 | 可选 | int |
| face_eye | 美颜——大眼，可增大眼睛，设定值范围：0~100 | 可选 | int |
| eyebag_removal | 美颜——祛眼袋，可减轻眼袋范围和颜色，设定值范围：0~100 | 可选 | int |
| hignnose | 美颜——高鼻梁，设定值范围：0~100 | 可选 | int |
| face_light | 美颜——脸部亮度，设定值范围：0~100 | 可选 | int |
| eye_light | 美颜——亮眼，设定值范围：0~100 | 可选 | int |
返回：
Http状态码为200时返回Json，包含证件照预览图片的Base64字符串，格式示例：
{ code : 0, msg : "", image:"证件照预览图base64字符串", width : 360, height : 480, warn : "" }
| 参数 | 说明 | 示例 | 类型 |
| code | 状态码 | 0 | int |
| msg | 消息 | 成功 | string |
| photoid |
证件照编号，用于下载证件照无水印文件用 （详见接口文档：2.证件照下载） |
- | string |
| image | 证件照预览图base64字符串 | /9j/4QAYRXhpZgAASUkqAAg************LW5zIy== | string |
| width | 宽度 | 360 | int |
| height | 高度 | 480 | int |
| warn | 照片建议 | 头部姿态不端正;照片亮度过低 | string |
Http状态码为400时表示处理错误并返回Json，格式示例：
{msg:"错误提示"}
| 错误提示 | 原因及解决办法 |
| 未授权的APIKey | APIKey不正确或已欠费，请检查、续费或联系客服（微信：cdipbsxf） |
| APIKey已停用 | APIKey已被停用 |
| APIKey已过期 | APIKey已过期 |
| 照片尺寸过大，无法处理 | 照片宽度或高度超过5000像素，请先压缩尺寸再提交接口 |
| 压缩范围不支持处理 | sizemin设置不得大于3000KB |
| 未找到合格人像，抠图失败，请更换照片 | 照片模糊、低质量、不包含人像，请更换清晰完整的单人正面免冠照 |
| 照片裁剪尺寸过大或者过小，请重新裁剪。 | - |
| 当前使用人数较多，请稍等重试 | 超过QPS限制，请稍后重试 |
| 照片不符合要求 | 照片人像方向错误、模糊等导致，请更换清晰完整的单人正面免冠照 |
2. 证件照下载
地址：https://www.dianzizhao.com/api/open/idphoto/download
请求方式：Get
数据类型：JSON
响应类型：Image
计费：此接口调用成功扣除API账户20点余额（约0.2元，实际根据充值金额会有所浮动）
参数[Header]
| 参数名 | 说明 | 是否必选 | 类型 |
| X-API-Key | 秘钥 | 必选 | string |
| Content-Type | 请求数据类型 | 必选 | application/json |
参数[Query]：
| 参数名 | 说明 | 是否必选 | 类型 |
| photoid | 证件照编号，来源于证件照预览接口的返回值 | 必填 | string |
返回：
Http状态码为200时返回图片流Http状态码为400时表示处理错误并返回Json，格式示例：
{msg:"错误提示"}
| 错误提示 | 原因及解决办法 |
| 未授权的APIKey | APIKey不正确或已欠费，请检查、续费或联系客服（微信：cdipbsxf） |
| APIKey已停用 | APIKey已被停用 |
| APIKey已过期 | APIKey已过期 |
| API账号点数不足 | 当前API账号点数余额不足以支付本次下载，请及时充值 |
| 证件照下载失败，请检查photoid是否正确 | photoid参数不正确 |
3. 证件照排版预览
文档编写中，如需使用请联系技术客服微信（微信号：cdipbsxf）
4. 证件照排版下载
文档编写中，如需使用请联系技术客服微信（微信号：cdipbsxf）