扫描接口 #
地址：https://www.clipimg.com/api/pic/scan
请求方式：POST
数据类型：JSON
响应类型：JSON
计费：此接口和裁剪、A4排版、预览及下载共用（qps =1/s、20/min）限制,不超过限制不产生费用；若超过qps限制需另外收费；如需开通高额度qps请联系客服。
参数[Header]
| 参数名 | 说明 | 是否必选 | 类型 |
| X-API-Key | 秘钥，点此获取 | 必选 | string |
| Content-Type | 请求数据类型 | 必选 | application/json |
参数[Body]：
| 参数名 | 说明 | 是否必选 | 类型 |
| file | Base64格式图片，不包含base64的头部数据 | 必选 | string |
| card_type | 证件类型，传值为类身份证证件卡片类型时会返回圆角图片 | 可选 | int |
| dpi | 返回的图片分辨率，如果不设置该值，服务端会给出默认配置，一般返回300dpi的图片 | 可选 | int |
card_type可取值
| 1 | 身份证 |
| 2 | 户口本 |
| 3 | 护照 |
| 4 | 驾驶证 |
| 5 | 行驶证 |
| 6 | 银行卡 |
| 7 | 文档 |
返回：
| 参数 | 说明 | 示例 | 类型 |
| code | 状态码 | 0 | int |
| msg | 错误详情 | 成功 | string |
| data | 结果 |
code取值
| 0 | 成功 |
| 402 | 点数已用完 |
| 400 | 参数错误 |
data接口结构
| 参数 | 说明 | 示例 | 类型 |
| points | 四个点的坐标，二维数组 | Eg: [[114, 92], …] | list |
| image_id | 上传图片标示 | 61b0…835_scan | string |
| filenames | 结果列表 | {‘preview_url’: ‘https://…’, ‘download_url’: ‘https://…’, ‘preview_img_name’: ‘af58…_scan_crop_preview’, ‘img_name’: ‘af58ef…_scan_crop’} | list |
filenames结构体
| 参数 | 说明 | 示例 | 类型 |
| preview_url | 预览图片地址 | https://…’ | string |
| preview_img_name | 预览图名称，用于再次下载 | af58ef…_scan_crop_preview | string |
| download_url | 原图下载地址 | https://…’ | string |
| img_name | 原图名称，用于再次下载 | af58ef…_scan_crop | string |
扫描裁剪接口 #
地址：https://www.clipimg.com/api/pic/scan/auto_crop
请求方式：POST
数据类型：JSON
响应类型：JSON
计费：此接口不产生费用
参数[Header]
| 参数名 | 说明 | 是否必选 | 类型 |
| X-API-Key | 秘钥 | 必选 | string |
| Content-Type | 请求数据类型 | 必选 | application/json |
参数[Body]：
| 参数名 | 说明 | 是否必选 | 类型 |
| image_id | 图片表示，在scan接口结果中获取到 | 必选 | string |
| points | 修正后四个点的坐标，二维数组 | 必选，Eg:[[114, 348], [543, 335], [560, 601], [105, 610]] | list |
| card_type | 证件类型，传值为类身份证证件卡片类型时会返回圆角图片 | 可选 | int |
card_type可取值
| 1 | 身份证 |
| 2 | 户口本 |
| 3 | 护照 |
| 4 | 驾驶证 |
| 5 | 行驶证 |
| 6 | 银行卡 |
| 7 | 文档 |
返回：
| 参数 | 说明 | 示例 | 类型 |
| code | 状态码 | 0 | int |
| msg | 错误详情 | 成功 | string |
| data | 结果 |
code取值
| 0 | 成功 |
| 402 | 点数已用完 |
| 404 | 文件不存在 |
| 400 | 参数错误 |
data结构体
| 参数名 | 说明 | 示例 | 类型 |
| preview_url | 预览图片地址 | https://…’ | string |
| preview_img_name | 预览图名称，用于再次下载 | af58ef…_scan_crop_preview | string |
| download_url | 原图下载地址 | https://…’ | string |
| img_name | 原图名称，用于再次下载 | af58ef…_scan_crop | string |
扫描裁剪A4排版接口 #
地址：https://www.clipimg.com/api/pic/scan/auto_crop_imgs
请求方式：POST
数据类型：JSON
响应类型：JSON
计费：此接口不产生费用
参数[Header]
| 参数名 | 说明 | 是否必选 | 类型 |
| X-API-Key | 秘钥 | 必选 | string |
| Content-Type | 请求数据类型 | 必选 | application/json |
参数[Body]：
| 参数名 | 说明 | 是否必选 | 类型 |
| card_type | 证件类型，传值为类身份证证件卡片类型时会返回圆角图片 | 必选 | int |
| list | 图片列表，card_type为1、2、4、6时list长度为2，为3时长度为1，为7时长度大于1 | 必选 | list |
card_type可取值
| 1 | 身份证 |
| 2 | 户口本 |
| 3 | 护照 |
| 4 | 驾驶证 |
| 5 | 行驶证 |
| 6 | 银行卡 |
| 7 | 文档 |
list结构体
| image_id | 图片表示，在scan接口结果中获取到 | 必选 | string |
| points | 修正后四个点的坐标，二维数组 | 必选，Eg:[[114, 348], [543, 335], [560, 601], [105, 610]] | list |
返回：
| 参数 | 说明 | 示例 | 类型 |
| code | 状态码 | 0 | int |
| msg | 错误详情 | 成功 | string |
| data | 结果 |
code取值
| 0 | 成功 |
| 402 | 点数已用完 |
| 404 | 文件不存在 |
| 400 | 参数错误 |
card_type为1、2、3、4、5、6时：
data结构体为
| 参数名 | 说明 | 示例 | 类型 |
| preview_url | 预览图片地址 | https://…’ | string |
| preview_img_name | 预览图名称，用于再次下载 | af58ef…_scan_crop_preview | string |
| download_url | 原图下载地址 | https://…’ | string |
| img_name | 原图名称，用于再次下载 | af58ef…_scan_crop | string |
card_type为7时：
data结构体为
| 参数名 | 说明 | 示例 | 类型 |
| imgs | 每张图片的扫描结果 | [{‘preview_url’: ‘https://…’, ‘download_url’: ‘https://…’, ‘preview_img_name’: ‘af58…_scan_crop_preview’, ‘img_name’: ‘af58ef…_scan_crop’},…] | list |
| 合并pdf后的结果 | {‘preview_url’: ‘https://…’, ‘download_url’: ‘https://…’, ‘preview_img_name’: ‘af58…_scan_crop_preview’, ‘img_name’: ‘af58ef…_scan_crop’} | object |
imgs及pdf结构体
| 参数名 | 说明 | 示例 | 类型 |
| preview_url | 预览图片（或pdf）地址 | https://…’ | string |
| preview_img_name | 预览图（或pdf）名称，用于再次下载 | af58ef…_scan_crop_preview | string |
| download_url | 原图（或pdf）下载地址 | https://…’ | string |
| img_name | 原图（或pdf）名称，用于再次下载 | af58ef…_scan_crop | string |
扫描预览 #
地址：https://www.clipimg.com/api/pic/scan/preview/预览图片（或pdf）名称
请求方式：GET
数据类型：JSON
响应类型：Image 或 octet-stream
计费：此接口不产生费用
参数：无
返回：httpcode为200时返回图片流（或pdf二进制流）
httpcode为404时表示图片（或pdf文件）不存在
扫描下载 #
地址：https://www.clipimg.com/api/pic/scan/download/原图片（或pdf）名称
请求方式：POST
数据类型：JSON
响应类型：Image 或 octet-stream
计费：此接口调用成功扣除API账户20点余额
参数[Header]
| 参数名 | 说明 | 是否必选 | 类型 |
| X-API-Key | 秘钥 | 必选 | string |
| Content-Type | 请求数据类型 | 必选 | application/json |
返回：httpcode为200时返回图片流（或pdf二进制流）
httpcode为404时表示图片（或pdf文件）不存在
httpcode为402时表示点数已用完
