/ocr/driving_license
优质
小牛编辑
132浏览
2023-12-01
1.接口描述
该 API 用于识别静态驾驶证图像上的文字信息。
- 图片要求:
- 格式为 JPG(JPEG),BMP,PNG,GIF,TIFF
- 宽和高大于 8px,小于等于 4000px
- 小于等于 5 MB
请求方式
POST
请求 URL
https://cloudapi.linkface.cn/ocr/driving_license
2.请求参数
字段 | 类型 | 必需 | 描述 |
---|---|---|---|
api_id | string | 是 | API 账户 |
api_secret | string | 是 | API 密钥 |
file | file | 见下方注释 | 需上传的图片文件,上传本地图片进行检测时选取此参数 |
url | string | 见下方注释 | 图片网络地址,采用抓取网络图片方式时需选取此参数 |
image_id | string | 见下方注释 | 图片的id,在云端上传过图片可采用此参数 |
请求参数
file
,url
与image_id
必须选择其中的一个。url 中含有不少特殊字符,若将 URL 放入 Query String 中则需要对这些字符进行转义,所有中文和特殊字符必需以UTF-8编码转义。 目前支持 http/https 等协议的网络地址。下载限时 5s,超时后仍未下载完成则属于失败。 参数
file
需把图片文件的内容以 multipart/form-data 的形式放到 POST 消息体中。
3.返回参数
字段 | 类型 | 说明 |
---|---|---|
request_id | string | 本次请求的id |
status | string | 返回状态,正常为 OK ,其他值表示失败,详见错误码 |
ocr_status | string | OCR识别结果,正常情况是OK ,不正常无该返回值 |
image_id | string | 使用file、url方式上传图片返回的图片的云端id |
result | array of object | 驾驶证文字信息, ocr_status 为OK 时才返回,详见result 数组中字段的结构 |
result
数组中字段的结构为:
字段 | 类型 | 说明 |
---|---|---|
license_number | string | 证件号 |
name | string | 姓名 |
gender | string | 性别 |
address | string | 住址 |
nationality | string | 国家 |
birthday | string | 出生日期 |
issue_date | string | 初始领证日期 |
class | string | 准驾车型 |
valid_from | string | 有效起始日期 |
valid_for | string | 有效期限 |
valid_date | string | 有效期时间段( 若version: 2 则有此字段 ) |
side | string | 正反面 |
version | string | 驾驶证版本, 1: 2008或更早版本, 2: 2013版本 |
驾驶证识别结果示例
version: 1 时返回结果
{
"request_id": "TID5685a175fb4e4197b3123ff7731ef81f",
"status": "OK",
"ocr_status": "OK",
"image_id": "ac65786ded0c43a6a086d3736b53f36d",
"result": {
"valid_from": "2013-02-15",
"gender": "男",
"issued_by": "湖南省********",
"issue_date": "2013-02-15",
"class": "C1",
"license_number": "430522199*******",
"valid_for": "6年",
"birthday": "1990-09-25",
"version": 1,
"address": "湖南省********",
"nationality": "中国",
"side": "front",
"name": "何**"
}
version: 2 时返回结果
{
"request_id": "TID5685a175fb4e4197b3123ff7731ef81f",
"status": "OK",
"ocr_status": "OK",
"image_id": "ac65786ded0c43a6a086d3736b53f36d",
"result": {
"valid_date": "2013-02-15 至 2019-02-15"
"valid_from": "2013-02-15",
"gender": "男",
"issued_by": "湖南省********",
"issue_date": "2013-02-15",
"class": "C1",
"license_number": "430522199*******",
"valid_for": "2019-02-15",
"birthday": "1990-09-25",
"version": 1,
"address": "湖南省********",
"nationality": "中国",
"side": "front",
"name": "何**"
}
}
4.错误码
状态码 | status 字段 | 说明 |
---|---|---|
400 | ENCODING_ERROR | 参数非UTF-8编码 |
400 | DOWNLOAD_TIMEOUT | 网络地址图片获取超时 |
400 | IMAGE_ID_NOT_EXIST | 图片不存在 |
400 | CORRUPT_IMAGE | 文件不是图片文件或已经损坏 |
400 | DOWNLOAD_ERROR | 网络地址图片获取失败 |
400 | IMAGE_FILE_SIZE_TOO_BIG | 图片体积过大 |
400 | INVALID_IMAGE_FORMAT_OR_SIZE | 图片大小或格式不符合要求 |
400 | INVALID_ARGUMENT | 请求参数错误,具体原因见 reason 字段内容 |
400 | INVALID_DRIVING_LICENSE | 驾驶证图片识别错误 |
401 | UNAUTHORIZED | 账号或密钥错误 |
401 | KEY_EXPIRED | 账号过期,具体情况见 reason 字段内容 |
403 | RATE_LIMIT_EXCEEDED | 调用频率超出限额 |
403 | NO_PERMISSION | 无调用权限 |
403 | OUT_OF_QUOTA | 调用次数超出限额 |
404 | NOT_FOUND | 请求路径错误 |
500 | OCR_SERVER_ERROR | 识别服务器异常 |
500 | INTERNAL_ERROR | 服务器内部错误 |
输出样例
{
"status": "INVALID_ARGUMENT",
"reason": "must specify 'image_id', 'file' or 'url' argument",
"request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}
5.输入示例
cURL 样例
curl -X POST "https://cloudapi.linkface.cn/ocr/driving_license?api_id=ID&api_secret=SECRET" \
-F file=@/PATH/TO/IMAGE
HTTPie 样例
http -f POST "https://cloudapi.linkface.cn/ocr/driving_license?api_id=ID&api_secret=SECRET" \
file@/PATH/TO/IMAGE