文档简介:
车牌识别接口说明
接口描述
针对图片中的车牌,进行OCR检测,返回检测到的车牌内容及车牌位置坐标
接口要求
图片格式:
1. 图片单张大小不超过 10MB,批量请求单次不超过 50张
2. 图片像素尺寸大于 32x32 ,小于 5000x5000
3. 图片格式支持 png、jpg、jpeg、bmp格式
请求说明
-
请求示例
HTTP方法:POST
请求URL:https://ai.ctyun.cn/v1/aiop/api/[系统生成的服务码]/driven-plate-ocr/platelicense.json
-
请求头说明
参数 |
值(说明) |
Content-Type |
application/json |
Sign |
MD5(AppKey + AppSecret + Timestamp + Path + Http Body),32位小写的MD5加密串 |
Timestamp |
13位时间戳 |
AppKey |
平台分配给应用独立的AppKey |
请求参数
参数 |
是否必选 |
类型 |
可选值范围 |
说明 |
data |
true |
list |
- |
请求参数放置于http body中,一张或多张图像Base64编码数据构成的list。注意:图片需要使用常规base64编码方式 |
-
请求代码示例
Bash:
curl -X POST "https://ai.ctyun.cn/v1/aiop/api/[系统生成的服务码]/driven-plate-ocr/platelicense.json" -H "Content-Type: application/json" -H 'Sign: XXXXX' -H 'Timestamp: XXXXX' -H 'AppKey: XXXXX' --data '{"data": ["9j_4AAQSkZJRgABAQAAAQABAAD_4QAwRXhpZgAATU0AKgAAA..."]}'
Python:
# -*- coding: utf-8 -*-
import requests
import base64
import hashlib
import time
import json
'''
车牌时别
'''
def md5(key):
input_name = hashlib.md5()
input_name.update(key.encode("utf-8"))
return input_name.hexdigest()
request_url = "车牌识别的API URL"
# 二进制方式打开图片文件
f = open('[本地文件]', 'rb')
img = "{}".format(base64.b64encode(f.read()).decode())
params = {"data": [img]}
app_key = '平台分配的APP Key'
app_secret = '平台分配的APP Secret '
time_stamp = str(int(round(time.time() * 1000)))
headers = {
'content-type': 'application/json',
'Sign': md5(app_key + app_secret + time_stamp + '/v1/aiop/api/[系统生成的服务码]/driven-plate-ocr/platelicense.json' + json.dumps(params)),
'Timestamp': time_stamp,
'AppKey': app_key
}
response = requests.post(request_url, data=json.dumps(params), headers=headers)
if response:
print(response.json())
返回说明
-
API调用成功返回值
返回字段 |
是否必选 |
类型 |
字段说明 |
code |
true |
int |
请求响应状态码 |
message |
true |
object |
请求信息结构体,message["success"]代表请求list中的成功数量,message["fail"]代表请求list中的失败数量。 |
result |
true |
json array |
识别的结果,按照列表形式排列,每个元素为图片对应的鉴定结果键值对,元素排序按照传入顺序排列,元素中包括识别到的车牌数目,位置以及车牌内容及其识别的置信度 |
result[].number of plate licenses |
true |
int |
图片中识别到的车牌数量 |
result[].detail |
true |
json array |
识别到的车牌的具体信息,包括位置、拍照类型、车牌内容、置信度等 |
result[].detail[].box |
true |
json array |
识别到的车牌8坐标位置信息,包含四个数组元素,依次分别对应车牌左上、右上、右下、左下四个点,每个数组元素包含两个整数,代表坐标点的x坐标,y坐标 |
result[].detail[].plate_type |
true |
string |
识别到的车牌种类信息,现阶段白牌、黑牌识别准确率较低 |
result[].detail[].platelicense |
true |
string |
识别到的车牌内容 |
result[].detail[].confidence |
true |
float |
识别到的车牌置信度 |
result[].err_code |
true |
int |
若该张图片处理异常,则返回该图片的错误代码,错误代码参见错误码说明 |
result[].err_msg |
true |
int |
若该张图片处理异常,则返回该图片的错误消息,错误消息参见错误码说明 |
-
API调用失败返回值
返回字段 |
是否必选 |
类型 |
字段说明 |
code |
true |
int |
错误码,参见本文档错误码说明部分 |
message |
true |
string |
返回对应的可读消息,值为error |
details |
true |
string |
错误消息 |
-
返回示例
HTTP/1.1 200 OK
Content-Type: application/json
{
"code": 0,
"message": {"success" : 1, "fail" : 0},
"result": [{
"number of plate licenses": 1,
"detail": [{
"box": [
[
123, 191
],
[
214, 195
],
[
213, 226
],
[
122, 222
]
],
"plate_type": "蓝牌",
"platelicense": "浙C80000",
"confidence": 1
}]
}]
}
错误码说明
错误码 |
错误信息 |
4001 |
请求JSON处理异常 |
4002 |
body传入的不是字典 |
4003 |
请求中未包data字段 |
4004 |
data字段图片数据不是list格式 |
4005 |
图片list内图片数量为0 |
4006 |
图片list内图片数量超过50张 |
4007 |
文件处理错误,请联系管理员 |
4008 |
base64数据处理异常 |
4009 |
请求文件格式不合法,仅支持 jpeg/png/jpg/bmp 格式 |
4010 |
单张图片大小超过10M |
4011 |
图片尺寸不符合要求,分辨率长宽尺寸应低于5000,高于32 |
4012 |
请求方法错误,请使用POST请求 |
4013 |
无效的请求路径,请确保请求路径正确 |
5000 |
服务接口异常,请联系管理员 |