/ocr/vehicle_license

优质
小牛编辑
169浏览
2023-12-01

1.接口描述

该 API 用于识别静态行驶证图像上的文字信息。

  • 图片要求:
    1. 格式为 JPG(JPEG),BMP,PNG,GIF,TIF
    2. 宽和高大于 8px,小于等于 4000px
    3. 小于等于 5 MB

请求方式

POST

请求 URL

https://cloudapi.linkface.cn/ocr/vehicle_license

2.请求参数

字段类型必需描述
api_idstringAPI 账户
api_secretstringAPI 密钥
filefile见下方注释需上传的图片文件,上传本地图片进行检测时选取此参数
urlstring见下方注释图片网络地址,采用抓取网络图片方式时需选取此参数
image_idstring见下方注释图片的id,在云端上传过图片可采用此参数

请求参数 file,urlimage_id 必须选择其中的一个。

url 中含有不少特殊字符,若将 URL 放入 Query String 中则需要对这些字符进行转义,所有中文和特殊字符必需以UTF-8编码转义。 目前支持 http/https 等协议的网络地址。下载限时 5s,超时后仍未下载完成则属于失败。 参数 file 需把图片文件的内容以 multipart/form-data 的形式放到 POST 消息体中。

3.返回参数

字段类型说明
request_idstring本次请求的id
statusstring状态,正常为 OK,其他值表示失败,详见错误码
ocr_statusstringOCR识别结果,正常情况是OK
image_idstring使用file、url方式返回的图片的id
resultarray of object行驶证文字信息, ocr_statusOK时才返回,详见result数组中字段的结构

result 数组中字段的结构:

字段类型说明
plate_nostring号牌号码
vehicle_typestring车辆类型
ownerstring所有人
addressstring住址
modelstring品牌型号
vinstring车辆识别代号
engine_nostring发动机号码
register_datestring注册日期
issue_datestring发证日期
use_characterstring使用性质
行驶证识别结果示例
{
    "request_id": "TID587cc3fdc4084b039308bfc2feb67c44",
    "status": "OK",
    "ocr_status": "OK",
    "image_id": "2e93d7a7ff6548ec884e23edcc199ed1",
    "result": {
        "plate_no": "桂N30***",
        "vehicle_type": "微型自卸货车",
        "owner": "袁**",
        "address": "广西******",
        "model": "红岩牌CQ3254SMHG384",
        "vin": "LZFF25M4X8D00****",
        "engine_no": "0812115****",
        "register_date": "2010-03-23",
        "issue_date": "2010-03-23",
        "use_character": "货运"
    }
}

4.错误码

状态码status 字段说明
400ENCODING_ERROR参数非UTF-8编码
400DOWNLOAD_TIMEOUT网络地址图片获取超时
400IMAGE_ID_NOT_EXIST图片不存在
400CORRUPT_IMAGE文件不是图片文件或已经损坏
400DOWNLOAD_ERROR网络地址图片获取失败
400IMAGE_FILE_SIZE_TOO_BIG图片体积过大
400INVALID_IMAGE_FORMAT_OR_SIZE图片大小或格式不符合要求
400INVALID_ARGUMENT请求参数错误,具体原因见 reason 字段内容
400INVALID_VEHICLE_LICENSE行驶证图片识别错误
401UNAUTHORIZED账号或密钥错误
401KEY_EXPIRED账号过期,具体情况见 reason 字段内容
403RATE_LIMIT_EXCEEDED调用频率超出限额
403NO_PERMISSION无调用权限
403OUT_OF_QUOTA调用次数超出限额
404NOT_FOUND请求路径错误
500OCR_SERVER_ERROR识别服务器异常
500INTERNAL_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/vehicle_license?api_id=ID&api_secret=SECRET" \
  -F file=@/PATH/TO/IMAGE
  • HTTPie 样例
http -f POST "https://cloudapi.linkface.cn/ocr/vehicle_license?api_id=ID&api_secret=SECRET" \
  file@/PATH/TO/IMAGE