# 港澳台通行证

版本 V1.0.0

# 1. 接口定义

# 1.1 接口

URL = http://ip:port/hex/ocrapi/hkmotwtravel_permit_ocr

其中 ip 为部署机器的 ip 地址，port 为对应服务器的端口

# 1.2 描述

汽车票OCR支持识别发票代码、发票号码、日期、姓名、票价等字段。可以应用于财务报销、账单核对等各种需要提取票据信息的场景。

# 1.3 HTTP请求格式

# 1.3.1 请求参数

参数名称		是否必选	类型	可选值	默认值	描述
app_id		是	String	无	无	接入优图服务时生成的唯一id，用于唯一标识接入业务
image		和url二选一	String	无	无	图像base64编码后的字符串，图像需是JPG、PNG、BMP其中之一的格式
url		和image二选一	String	无	无	图片url地址，url与image两者填一个即可，同时赋值时，则以url指定的图像作为输入
session_id		否	String	无	无	用户自定义的唯一会话id
options
options	ret_image	否	String	preprocess/portrait/""	""	默认为空， ret_image的取值以及含义如下： 1.preprocess:返回预处理后的图片数据 2.portrait:返回人像图片数据 3."":不返回图片数据注：此处图片数据是图片base64加密后的字符串

# 1.3.2 请求示例

Request:
{
 "app_id": 填写对应的app_id,
 "image": 填写Base64编码后的图片数据,
 "session_id": 填写对应的session_id
}

1
2
3
4
5
6

# 1.3.3 返回参数

字段		是否必然返回	类型	说明
angle		是	Float	图片旋转角度（角度制），文本的水平方向为0°；顺时针为正，逆时针为负
errorcode		是	Int32	错误码
errormsg		是	String	错误码消息
session_id		否	String	相应请求的session标识符，可用于结果查询
image		否	String	图片数据，返回证照中的肖像或预处理后图像
items
	item	是	String	识别出的字段名称(关键字)，支持以下字段：类型、机读码、姓名、证件号、出生日期、英文姓名、有效期限、性别、签发地点、签发机关
	itemstring	是	String	识别出的字段名称对应的值，也就是字段item对应的字符串结果
	itemconf	是	Float	置信度
	itemcoord	是	Object	文本行在旋转纠正之后的图像中的像素坐标，表示为（左上角x, 左上角y，宽width，高height）

# 1.3.4 返回示例

Response:
{
  "angle": 0,
  "errormsg": "OK",
  "session_id": "",
  "errorcode": 0,
  "items": [
    {
      "itemstring": "公安部出入境管理局",
      "item": "签发机关",
      "itemconf": 0.9999894499778748,
      "itemcoord": {
        "y": 324,
        "x": 243,
        "height": 27,
        "width": 322
      }
    }
  ]
}

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

# 1.3.5 接口错误码说明

错误码	错误码消息	错误码说明
400	HTTP_BAD_REQUEST	请求不合法，包体格式错误
401	HTTP_UNAUTHORIZED	权限验证失败
403	HTTP_FORBIDDEN	鉴权信息不合法，禁止访问
404	HTTP_NOTFOUND	请求失败
411	HTTP_REQ_NOLENGTH	请求没有指定ContentLength
413	HTTP_REQUEST_LARGE	请求包体太大
424	HTTP_METHOD_NOTFOUND	请求的方法没有找到
500	HTTP_INTERNAL_SERVER_ERROR	服务内部错误
502	HTTP_BAD_GATEWAT	网关错误，计算后台服务不可用
503	HTTP_SERVICE_UNAVAILABLE	服务不可用
504	HTTP_GATEWAY_TIME_OUT	后端服务超时或者处理失败
510	HTTP_NOT_EXTENDED	请求频率限制

← 护照港澳台居住证 →