/ocr/vin

1.接口描述

该 API 用于识别图像上的VIN码。

  • 图片要求：
    1. 格式为 JPG（JPEG），PNG
    2. 宽和高大于 128px，小于等于 6000px
    3. 小于等于 5 MB

请求方式

POST

请求 URL

https://cloudapi.deepfinch.com/ocr/vin

调试工具

Debugging Tool

2.请求参数

2.1 请求头域

字段 类型 必需 描述
X-DF-API-ID string 是 API调用凭证信息，详细信息请参考API调用
X-DF-API-SECRET string 是 API调用凭证信息，详细信息请参考API调用

2.2 请求体

字段 类型 必需 描述
file file 见下方注释 需上传的图片文件，上传本地图片进行检测时选取此参数
url string 见下方注释 图片网络地址，采用抓取网络图片方式时需选取此参数
query_vin bool 否 查询VIN码对应的车辆信息，默认为false

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

3.返回参数

字段 类型 说明
request_id string 本次请求的id
status string 返回状态，正常为 OK, 其他值表示失败，详见错误码
result object 识别信息，详见result 中字段的结构

result 字段的结构为：

字段 类型 说明
rect Array 图片中VIN码的坐标，格式为 [左上角X, 左上角Y，右下角X，右下角Y]
vin string 车辆VIN码
car_info string 当query_vin为true时，会返回VIN码对应的车辆信息，当查询不到信息时，返回为空
返回结果示例
{
    "request_id": "TIDf7802c753b3048eb8524f2dc143b7a70",
    "status": "OK",
    "result": {
        "rect": [25, 119, 493, 157],
        "car_info": "上海通用 别克 君越（君越）三厢 2011款 2.4L 自动 2.4 SIDI 手自一体 舒适版",
        "vin": "LSG***********458"
    }
}

4.错误码

状态码 status 字段 说明
400 INVALID_ARGUMENT 请求参数错误
400 DETECTION_FAILED 图片检测失败
400 DOWNLOAD_ERROR 网络地址图片获取失败
401 UNAUTHORIZED 未授权或授权失败
401 KEY_EXPIRED 账号过期
403 NO_PERMISSION 无调用权限
403 OUT_OF_QUOTA 调用次数超出限额
403 RATE_LIMIT_EXCEEDED 调用频率超出限额
404 NOT_FOUND 请求路径错误
500 INTERNAL_ERROR 服务器内部错误

备注: 以上40X系列错误描述请参考reason字段

输出样例
{
  "status": "INVALID_ARGUMENT",
  "reason": "must specify 'file' or 'url' argument",
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}

5.输入示例

results matching ""

    No results matching ""