# OCR平台接口设计总述

版本 V1.2

# 1. 通讯协议

HTTPS + JSON，需支持多种协议。contentType/json/formdata 格式

# 1.1 HTTPS 协议

HTTP 在 TCP/IP 之上进行通信。客户机使用 TCP 连接到服务器：

POST /ocr HTTPS/1.1
Host: ***.***.***.***
Content-Type: application/json
Accept-Charset: UTF-8

1
2
3
4

随后服务器会处理此请求，然后向客户机发送一个 HTTP 响应。此响应包含了可指示请求状态的状态代码：

200 OK
Content-Type: application/json

1
2

在上面的例子中，服务器返回了一个 200 的状态代码。这是 HTTP 的标准成功代码。

假如服务器无法对请求进行解码，它可能会返回类似这样的信息：

400 Bad Request

# 1.1.1 HTTP URL

HTTP POST 请求规定至少两个 HTTP 头：Content-Type 和 Accept-Charset。

# 1.1.1.1 语法

Content-Type: application/json; Accept-Charset=UTF-8

# 1.1.1.2 例子

POST /ocr HTTP/1.1
Content-Type: application/json;Accept-Charset=UTF-8

1
2

# 1.2 请求地址

//同步调用接口同时支持这种请求格式
http://{ip}:{port}/hex/ocrapi
http://{ip}:{port}/hex/ocrapi/{识别服务}

1
2
3
4
5

# 1.3 JSON报文格式

# 1.3.1 请求报文

# 1.3.1.1 报文结构

字段英文名	标准中文名称	数据类型	约束条件	必输	说明
ocrtype	识别类型	String	识别类型（带识别服务的可不填）	-	当请求地址中带有识别服务时可不填
ocrsubtype	识别子类型	String	根据ocrtype决定是否输入	-
actionid	交易流水号	String		N
channelcode	渠道码	String	由后管设置是否必填	-
ip	请求机器IP	String	如果没填，从请求中获取IP	N
session_id	会话ID	String	会话ID，保持唯一	N
image	base64数据	String	和url二选一	-
url	影像url	String	和image二选一	-
pdf_page_index	PDF页码	String	PDF识别页码（不传默认第1页)	N
…	可变字段	…	根据识别类型不一致，而不一致	N

参数 image 和url 两个参数提供外部系统任选一种方式传输影像文件。如两个参数都传值系统默认取image内容识别。

image: 外部系统直接传输识别图片的base64编码数据调用接口,支持PDF,PNG,TIF,JPG,JPEG,BMP

url：外部系统将影像上传至影像平台，传输影像平台图片路径调用接口

识别类型(ocrtype)参数定义：

序号	ocrtype	说明
1	00000001	身份证
2	00000002	银行卡
3	00000003	户口本
4	00000004	驾驶证
5	00000005	行驶证
6	00000006	不动产登记证
7	00000007	房产证
8	00000008	营业执照
9	00000009	增值税普通发票
10	00000012	增值税卷票
11	00000013	定额发票
12	00000014	机票行程单
13	00000015	火车票
14	00000016	汽车票
15	00000017	出租车票
16	00000018	轮船票
17	00000019	发票混排
18	00000020	通用机打发票
19	00000021	过路票
20	00000022	购车发票
21	00000023	二手车发票
22	00000024	完税证明
23	00000025	事业单位法人证书
24	00000026	组织机构代码证
25	00000030	通用印刷体文字
26	00000031	通用手写体文字
26	00000032	智能结构化
27	00000040	国内护照
28	00000041	国际护照
29	00000053	企业证照
30	00001000	通用表单
31	00001001	划款指令
32	00001002	模型服务
33	00001003	证件分类
34	00001100	财报
35	00001011	机动车登记证书
36	00001012	通用结构化
37	00001013	国际护照
38	00001014	金融票据
39	00001015	车牌识别
40	00001016	高精度文字识别
41	00001017	港澳台来往内地通行证
42	00001018	港澳台居住证
43	00001019	图像分类
44	00001020	印章识别服务
45	00001021	车辆VIN码
46	00001022	表格识别
47	00001023	名片

识别子类型(ocrsubtype)参数定义：当识别类型为固定板式(ocrtype =00001000)时，即影像类型为自定义配置模板时，需要传输识别子类型(ocrsubtype),指定需要识别的模板。

序号	ocrsubtype	说明
1	00000001	国有土地使用证
2	00000002	建设用地规划许可证
3	00000003	建设工程规划许可证
4	00000004	建筑工程施工许可证
		自定义配置的凭证

# 1.3.1.2 完整的请求报文例子

{
    "session_id":"3255-a62655-abcd3d-dfsf",
    "channelcode":"0010",
    "actionid":"0010",
    "ip":"127.0.01",
    "ocrtype":"00000015",
    "ocrsubtype":"",
    "image":"",
    "url":""    
}

1
2
3
4
5
6
7
8
9
10

# 1.3.2 响应报文

# 1.3.2.1 响应报文格式

英文名称	中文名称	数据类型	约束条件	是否必然返回
errorcode	识别响应码	int		Y
errormsg	响应码描述	String		Y
session_id	会话ID	String		Y
channelcode	渠道代码	String		Y
ip	请求IP			N
angle	图片角度			N
items	返回结果	Arrray	单证件返回结果	N
mixitems	返回结果	Arrray	混排返回结构体	N

# 1.3.2.2 完整应答报文例子

{
"errorcode":0,
"errormsg":"OK",
"session_id":"",
"channelcode":"EJ0020",
"ip":"127.0.0.85",
"angle":0,
"items":[
        {
            "itemstring":"LNBMDLAA6HR894143",
            "item":"车辆识别代号/车架号码",
            "itemconf":0.9999364018440247,
            "itemcoord":{
                "y":552,
                "x":493,
                "height":21,
                "width":401
            }
       }
    ]
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

# 1.3.2.3 完整错误报文例子

{
    "errorcode":-1290,
    "errormsg":"不支持的文件格式",
    "session_id":"",
    "channelcode":"EJ0020",
    "ip":"127.0.0.85",
    "angle":0
}

1
2
3
4
5
6
7
8

# 2. 公共错误码定义

错误码	说明
-1000	请求参数格式错误
-1300	图片为空
-1301	必填参数为空
-5208	服务器内部错误
-1102	图片解码失败
-1400	模板不匹配
-9003	OCR识别失败
-50001	OCR识别类型错误
-50002	未授权
-50003	识别结果为空
-50004	启用认证
-50005	服务不可用

通用印刷体文字 →