港澳台居住证识别接口
接口描述
用户通过发送HTTP Post请求方式提交数据至公有云服务器,服务器识别并返回json格式的识别结果。
测试页面
API 定义
/ocr/v1/gat_jzz
URL地址
请求方式:
HTTP Post
Header
参数 | 值 |
---|---|
Content-Type | 使用二进制方式时,为multipart/form-data;使用url方式时,为application/x-www-form-urlencoded |
请求参数
参数 | 必选 | 类型 | 说明 |
---|---|---|---|
app_key | 是 | string | 请在控制台->我的应用中获取 |
app_secret | 是 | string | 请在控制台->我的应用中获取 |
image_base64 | 否 | string | 图像base64串。image_base64、image_url、image_binary三个参数中至少选择一个,读取优先级从前到后依次降低。如:同时选择了以上三个参数,则以image_base64图像为准。 |
image_url | 否 | string | 图像url地址。image_base64、image_url、image_binary三个参数中至少选择一个,读取优先级从前到后依次降低。如:同时选择了以上三个参数,则以image_base64图像为准。 |
image_binary | 否 | data | 图像二进制。image_base64、image_url、image_binary三个参数中至少选择一个,读取优先级从前到后依次降低。如:同时选择了以上三个参数,则以image_base64图像为准。 |
调用示例
java(相关依赖库下载)
package com.exocr.httpclient;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.util.HashMap;
import java.util.Map;
import com.exocr.common.utils.HttpClientUtils;
public class Test {
public static void main(String[] args) throws FileNotFoundException {
/**
* base64
*/
//识别url
String url = " http://api.exocr.com/ocr/v1/gat_jzz";
//设置请求参数
Map<String, String> params = new HashMap<String, String>();
params.put("app_key", "#####");
params.put("app_secret", "#####");
//设置识别图像base64编码
params.put("image_base64", "base64ImageStr");
//发送请求,得到识别结果
String result = HttpClientUtils.doPost(url, params);
System.out.println(result);
/**
* url
*/
//设置请求参数、识别图像url
params.put("app_key", "#####");
params.put("app_secret", "#####");
params.put("image_url", "imageUrl");
//发送请求,得到识别结果
result = HttpClientUtils.doPost(url, params);
System.out.println(result);
/**
* 二进制
*/
//设置请求参数
params.put("app_key", "#####");
params.put("app_secret", "#####");
//拿到本地图像,写入数据流
File file = new File("/Users/mac/logs/table.png");
InputStream in = new FileInputStream(file);
//设置数据流
Map<String, InputStream> streamMap = new HashMap<String, InputStream>();
streamMap.put("image_binary", in);
//发送请求,得到识别结果
result = HttpClientUtils.doPostStream(url, params, streamMap);
//关闭io流
try {
in.close();
} catch (IOException e) {
e.printStackTrace();
}
System.out.println(result);
}
}
返回结果示例
{
"description":"识别成功",
"error_code":0,
"result":{
"gender":{
"position":{
"width":271,"top":314,"height":22,"left":218
},
"chinese_key":"性别",
"score":0.991656,
"words":"男",
"quad":"218,316,489,314,489,333,218,336"
},
"birthdate":{…},
"idno":{…},
"pass_no":{…},
"address":{…},
"nationality":{…},
"name":{…},
"issued":{…},
"valid":{…}
},
"request_id":"88d9e57a0c3b11ea8681fa163e375239",
"recognize_time":1454,
"dbg_xml":""
}
返回说明
通用参数
参数 | 类型 | 说明 |
---|---|---|
error_code | int | 错误码,返回0为正确,其他为错误 |
description | string | 识别结果描述 |
request_id | string | 请求唯一标识符 |
recognize_time | int | 识别所用时间,单位为毫秒 |
available_count | int | 识别剩余可用次数,次数不足时无法继续识别,可在控制台进行充值次数 |
result | Array | 识别内容 |
version | string | 版本 |
返回结果
字段 | 说明 | 类型 | 备注 |
---|---|---|---|
name | 姓名 | Array | |
gender | 性别 | Array | |
pass_no | 通行证号码 | Array | |
idno | 身份证号码 | Array | |
address | 地址 | Array | |
birthdate | 出生日期 | Array | |
valid | 有效期限 | Array | |
issued | 签发机关 | Array | |
chinese_key | 该字段中文含义 | String | |
words | 识别结果 | String | utf-8格式 |
score | 照片可信度 | Float | 取值范围为0~1 |
quad | 四个顶点坐标 | String | 所在区域的四个点,依次为左上,右上,右下,左下四个点的坐标值 |
position | 位置矩形框 | Array | 以左上角为基准,距离左侧,上侧,右侧矩形框长度,下侧矩形框长度 |
left | 位置值 | Int | 距离原图左侧距离x,单位为像素 |
top | 位置值 | Int | 距离原图上方距离y,单位为像素 |
width | 位置值 | Int | 字段所在图框宽度w,单位为像素 |
height | 位置值 | Int | 字段所在图框高度h,单位为像素 |
issued_times | 换证次数 | Object |