ocr 识别 api · 易道博识 ocr识别api 接口调用规范 v1.0 2018/8/3
TRANSCRIPT
易道博识
OCR 识别 API
接口调用规范
v1.0
2018/8/3
北京易道博识科技有限公司 www.exocr.com
目录
1 概述..................................................................................................................................................31.1 简介...............................................................................................................................31.2 接口调用方式...............................................................................................................3
2 接口详细定义..................................................................................................................................52.1 身份证识别接口.......................................................................................................... 52.2 银行卡识别接口.......................................................................................................... 72.3 增值税发票识别接口.................................................................................................. 82.4 营业执照识别............................................................................................................ 102.5 驾驶证识别................................................................................................................ 112.6 行驶证识别................................................................................................................ 13
3. 增值税发票返回列表......................................................................................................... 144. 营业执照返回列表............................................................................................................. 15
北京易道博识科技有限公司 www.exocr.com
1 概述
1.1 简介
客户端通过 HTTP POST方式提交 JSON格式数据至识别服务器,识别服务器识
别完成后通过 JSON格式返回处理结果。
1.2 接口调用方式
1.2.1 获取 AppKey 和 AppSecret
API 订购成功成功后,进入我的应用→已购买的应用,即可获取该 API 的 AppKey
AppSecret
1.2.2 下载 sdk
接口调用应使用华为 SDK。
登录华为云控制台→在服务列表中选择“应用服务”→API 网关→调用
API→SDK,根据开发语言下载相应 SDK 包,地址为:
https://console.huaweicloud.com/apig/?region=cn-north-
1#/apig/manager/useapi/sdk
北京易道博识科技有限公司 www.exocr.com
1.2.3 Python示例代码
import requestsfrom apig_sdk import signer
def request_huawei(file_path, app_key, app_secret):sig = signer.Signer()sig.AppKey = app_keysig.AppSecret = app_secret
r = signer.HttpRequest()r.scheme = "https"r.host = "ocr.apistore.huaweicloud.com"r.method = "POST"r.uri = "/ocr/v1/id_card"
image_data = Nonewith open(file_path, 'r') as f:
image_data = f.read()
request_body = json.dumps({"image_base64":base64.b64encode(image_data)})
r.headers = {"x-stage": "RELEASE"}if sys.version_info.major < 3:
r.body = request_body
北京易道博识科技有限公司 www.exocr.comelse:
r.body = request_body.encode("utf-8")sig.Sign(r)resp = requests.request(r.method, r.scheme + "://" + r.host + r.uri,
headers=r.headers, data=r.body)print(resp.status_code, resp.reason)print(resp.content)
2 接口详细定义
2.1 身份证识别接口
API定义
/ocr/v1/id_card
请求 URL
https://ocr.apistore.huaweicloud.com/ocr/v1/id_card
Header
content-type: application/json
Request数据
image_base64 ----------------------- base64 格式参数
请求 Body
{“image_base64”:”/”
}
北京易道博识科技有限公司 www.exocr.com
Response内容
返回为 JSON 格式,格式如下
error_code ------------------- 错误码,整数,0 为正确返回,其他为错误
description ------------------- 识别结果描述,字符串格式
request_id -------------------- 请求唯一标识符,字符串,用于回溯问题
recognize_time -------------------- 识别所用时间,以毫秒为单位
result --------------------------- 识别结果列表,JSON 串
result 内容如下:
result: //识别结果,json,如果错误码为 0,才有结果
{face://当前为哪一面,1=人像面,2=国徽面
name:{
words: //识别结果
score: //识别可信度
position: //位置
{left:top:width:height:
}gender:nationality:idno:address:birthdate:issued:valid:
}head_info:
position:{
left:top:width:height:
}returned_head_image:
}
北京易道博识科技有限公司 www.exocr.composition ------------------------------------------位置信息
words ---------------------------------------------识别结果字符串,utf-8 格式
score------------------------------------------------照片可信度,浮点数,取值范围为 0~1
2.2 银行卡识别接口
API定义
/ocr/v1/bank_card
请求 URL
https://bankcardocr.apistore.huaweicloud.com/ocr/v1/bank_card
Header
content-type: application/json
Request数据
image_base64 ----------------------- base64 格式参数
请求 Body
{“image_base64”:””
}
Response内容
返回为 JSON 格式,格式如下
error_code ------------------- 错误码,整数,0 为正确返回,其他为错误
description ------------------- 识别结果描述,字符串格式
request_id -------------------- 请求唯一标识符,字符串,用于回溯问题
recognize_time -------------------- 识别所用时间,以毫秒为单位
result --------------------------- 识别结果列表,JSON 串
北京易道博识科技有限公司 www.exocr.com
result 内容如下:
result: //识别结果,json,如果错误码为 0,才有结果
{bank_name: //银行名称
{words: //识别结果
score: //识别可信度
position: //位置
{left:top:width:height:}
}card_name: //卡名称
card_type: //卡类型
valid_thru: //有效期
card_no: //卡号
}
position ----------------------------------------位置信息
words ---------------------------------------------识别结果字符串,utf-8 格式
score--------------照片可信度,浮点数,取值范围为 0~1
2.3 增值税发票识别接口
API定义
/ocr/v1/invoice
请求 URL
https://ocr1.apistore.huaweicloud.com/ocr/v1/invoice
Header
content-type: application/json
北京易道博识科技有限公司 www.exocr.com
Request数据
image_base64 ----------------------- base64 格式参数
请求 Body
{“image_base64”:””
}
Response内容
返回为 JSON 格式,格式如下
error_code ------------------- 错误码,整数,0 为正确返回,其他为错误
description ------------------- 识别结果描述,字符串格式
request_id -------------------- 请求唯一标识符,字符串,用于回溯问题
recognize_time -------------------- 识别所用时间,以毫秒为单位
result --------------------------- 识别结果列表,JSON 串
result 内容如下:
result:{
invoice_no1:{
chinese_key:“发票号码 1”words: //识别结果
score: //识别可信度
position: //位置
{left:top:width:height:
}}… //其他字段,请见附录
}position ----------------------------------------位置信息
words ---------------------------------------------识别结果字符串,utf-8 格式
score--------------照片可信度,浮点数,取值范围为 0~1
北京易道博识科技有限公司 www.exocr.com
2.4 营业执照识别
API定义
/ocr/v1/business_license
请求 URL
https://ocr2.apistore.huaweicloud.com/ocr/v1/business_license
Header
content-type: application/json
Request数据
image_base64 ----------------------- base64 格式参数
请求 Body
{“image_base64”:””
}
Response内容
返回为 JSON 格式,格式如下
error_code ------------------- 错误码,整数,0 为正确返回,其他为错误
description ------------------- 识别结果描述,字符串格式
request_id -------------------- 请求唯一标识符,字符串,用于回溯问题
recognize_time -------------------- 识别所用时间,以毫秒为单位
result --------------------------- 识别结果列表,JSON 串
result 内容如下:
result:{
no:
北京易道博识科技有限公司 www.exocr.com{
chinese_key: “统一社会信用信用代码”
words: //识别结果
score: //识别可信度
position: //位置
{left:top:width:height:
}}… //其他字段,请见附录
}
position ----------------------------------------位置信息
words ---------------------------------------------识别结果字符串,utf-8 格式
score--------------照片可信度,浮点数,取值范围为 0~1
2.5 驾驶证识别
API定义
/ocr/v1/driver_license
请求 URL
https://ocr3.apistore.huaweicloud.com/ocr/v1/driver_license
Header
content-type: application/json
Request数据
image_base64 ----------------------- base64 格式参数
北京易道博识科技有限公司 www.exocr.com
请求 Body
{“image_base64”:””
}
Response内容
返回为 JSON 格式,格式如下
error_code ------------------- 错误码,整数,0 为正确返回,其他为错误
description ------------------- 识别结果描述,字符串格式
request_id -------------------- 请求唯一标识符,字符串,用于回溯问题
recognize_time -------------------- 识别所用时间,以毫秒为单位
result --------------------------- 识别结果列表,JSON 串
result 内容如下:
result:{
license_no: //证号
{words: //识别结果
score: //识别可信度
position: //位置
{left:top:width:height:
}}name: //姓名
sex: //性别
nationality: //国籍
address: //住址
birth_date: //出生日期
issue_date://初次领证日期
dr_class: //准驾车型
valid_period: //有效期限
}position ----------------------------------------位置信息
words ---------------------------------------------识别结果字符串,utf-8 格式
score--------------照片可信度,浮点数,取值范围为 0~1
北京易道博识科技有限公司 www.exocr.com
2.6 行驶证识别
API定义
/ocr/v1/vehicle_license
请求 URL
https://ocr4.apistore.huaweicloud.com/ocr/v1/vehicle_license
Header
content-type: application/json
Request数据
image_base64 ----------------------- base64 格式参数
请求 Body
{“image_base64”:””
}
Response内容
返回为 JSON 格式,格式如下
error_code ------------------- 错误码,整数,0 为正确返回,其他为错误
description ------------------- 识别结果描述,字符串格式
request_id -------------------- 请求唯一标识符,字符串,用于回溯问题
recognize_time -------------------- 识别所用时间,以毫秒为单位
result --------------------------- 识别结果列表,JSON 串
result 内容如下:
result:{
plateno: //号牌号码
北京易道博识科技有限公司 www.exocr.com{
words: //识别结果
score: //识别可信度
position: //位置
{left:top:width:height:
}}vehicle_type: //车辆类型
owner: //所有人
address: //住址
use_character: //使用性质
model: //品牌型号
vin: //车辆识别代码
engine_no: //发动机号码
register_date: //注册日期
issue_date://发证日期
}
position ----------------------------------------位置信息
words ---------------------------------------------识别结果字符串,utf-8 格式
score--------------照片可信度,浮点数,取值范围为 0~1
3. 增值税发票返回列表
字段名称 Key 字段分类
发票号码 1 invoice_no1 号码信息
发票号码 2 invoice_no2发票代码 1 invoice_code1发票代码 2 invoice_code2购方名称 buyer_name 购方信息
购方纳税人识别号 buyer_tax_no购方地址电话 buyer_address购方开户行及账号 buyer_bank_info销方名称 seller_name 销房信息
销方纳税人识别号 seller_tax_no销方地址电话 seller_address销方开户行及账号 seller_bank_info价税合计(大写) amount_big 金额信息
价税合计(小写) amount_small
北京易道博识科技有限公司 www.exocr.com合计金额 total合计税额 total_tax收款人 receiver 其他信息
复核 check开票人 creator密码区 password_area开票日期 create_date
4. 营业执照返回列表
字段名称 Key 版式分类
统一社会信用代码 no 版式 1名称 name类型 type住所 address法定代表人 representive注册资本 capital成立日期 found_date营业期限 expire_date经营范围 businesss_scope统一社会信用代码 no 版式 2名称 name类型 type营业场所 address负责人 representive成立日期 found_date营业期限 expire_date经营范围 businesss_scope统一社会信用代码 no 版式 3名称 name主体类型 type住所 address法定代表人 representive成立日期 found_date注册号 no 版式 4名称 name类型 type住所 address法定代表人 representive注册资本 capital成立日期 found_date
北京易道博识科技有限公司 www.exocr.com营业期限 expire_date经营范围 businesss_scope注册号 no 版式 5名称 name类型 type经营场所 address经营者 representive组成形式 organization_type注册日期 register_date经营范围 businesss_scope注册号 no 版式 6名称 name类型 type营业场所 address负责人 representive成立日期 found_date营业期限 expire_date经营范围 businesss_scope注册号 no 版式 7名称 name类型 type住所 address出资人 representive成立日期 found_date经营范围 businesss_scope注册号 no 版式 8名称 name住所 address法定代表人姓名 representive注册资本 capital公司类型 type实收资本 actual_capital经营范围 businesss_scope成立日期 found_date营业期限 expire_date