证件照排版

描述

本接口用于证件照排版

接口鉴权

接口地址

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

请求头（request header）

字段	类型	是否必填	字段描述
app_id	string	是	应用ID，获取方式：应用列表 -> 应用详情 -> APP ID

请求体（request body）

字段	类型	是否必填	字段描述
url	string	二个必填一个优先级：url>file_base64	原图url，支持JPG、PNG格式仅保留1个月，请及时转储（无文件大小限制）
file_base64	string	二个必填一个优先级：url>file_base64	原图的base64码（最大支持3M文件）
result_type	string	否	结果返回类型：枚举值：url，base64 默认url
background_width	number	否	排版背景宽度，默认值1500，默认以五寸背景进行排版（1500 X 1051）
background_height	number	否	排版背景高度，默认值1051，默认以五寸背景进行排版（1500 X 1051）
file_type	number	否	获得图片类型 jpg , png
passport_background	string	否	证件照背景色如 #ffffff
dpi	number	否	DPI

请求体示例（url）：

{
   "url":"https://matting-batch.dancf.com/cloths/20220825_143743_gaoding_imagematting_human_one.png",
   "passport_background": "#dcdcdc"
}

请求体示例（base64）：

{
   "file_base64":"图片的base64编码",
   "passport_background": "#ffffff"
}

响应体（response body）

字段	类型	是否必存在	字段描述
result	string	是	url入参：结果图url，返回PNG格式，仅保留1个月，请及时转储 base64入参：返回图片base编码
width	number	是	图片宽
height	number	是	图片高
dpi	number	是	DPI

响应示例1（模拟正常请求：url入参）：

http_status：200

response body：

{
    "result": "https://gd-filems.dancf.com/gaoding/matting/typesetting/b807741f894219e734ff25adf92d361b1661494224745.jpg",
    "width": 1500,
    "height": 1051,
    "dpi": 300
}

响应示例2（模拟正常请求：base64入参）：

http_status：200

response body：

{
  "width": 1500,
  "height": 1501,
  "result": "图片的base64编码",
  "dpi": 300
}

响应示例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		接口入参错误

响应示例2（模拟正常请求：base64入参）：

响应示例3（模拟参数非法请求）：

错误码