身份证识别
接口描述
用户通过发送HTTP Post请求方式提交数据至公有云服务器，服务器识别并返回json格式的识别结果。
接口说明
请求URL：http://api.exocr.com/ocr/v1/id_card
请求方式：HTTP Post
返回格式：json
Header
| 参数 | 值 |
|---|---|
| Content-Type | 使用二进制方式时，为multipart/form-data；使用base64和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/id_card";
//设置请求参数
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/idcard.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);
}
}
返回示例
{
"result": {
"face": 1,
"name": {
"words": "张三",
"score": 0.9999,
"position": {
"left": 161,
"top": 87,
"width": 69,
"height": 26
}
},
"gender": {
"words": "男",
"score": 0.9999,
"position": {
"left": 160,
"top": 135,
"width": 29,
"height": 23
}
},
"nationality": {
"words": "汉",
"score": 0.9999,
"position": {
"left": 270,
"top": 135,
"width": 27,
"height": 22
}
},
"idno": {
"words": "##########",
"score": 0.9999,
"position": {
"left": 244,
"top": 328,
"width": 298,
"height": 26
}
},
"address": {
"words": "北京市",
"score": 0.9999,
"position": {
"left": 162,
"top": 220,
"width": 229,
"height": 25
}
},
"birthdate": {
"words": "1992.11.3",
"score": 0.9999,
"position": {
"left": 160,
"top": 175,
"width": 180,
"height": 23
}
},
"issued": null,
"valid": null,
"head_info": null,
"returned_image": ""
},
"error_code": 0,
"description": "识别成功",
"request_id": "FA336B9CDBF444C7BA314A45C9891CED",
"recognize_time": 401,
"available_count": 19698
}
返回说明
通用参数
| 参数 | 类型 | 说明 |
|---|---|---|
| result | array | 返回结果数组，包括所有字段的识别信息 |
| error_code | int | 错误码，返回0为正确，其他为错误 |
| description | string | 识别结果描述 |
| request_id | string | 请求唯一标识符 |
| recognize_time | int | 识别所用时间，单位为毫秒 |
| available_count | int | 识别剩余可用次数，次数不足时无法继续识别，可在控制台进行充值次数 |
身份证识别特有参数
| 参数 | 类型 | 说明 |
|---|---|---|
| issued | string | 签发机关 |
| valid | string | 有效期 |
| face | int | 当前身份证正反面（1为人像面，2为国徽面） |
| name | string | 姓名 |
| gender | string | 性别 |
| nationality | string | 民族 |
| idno | string | 身份证号码 |
| address | string | 地址 |
| birthdate | string | 生日 |
| words | string | 当前字段的值 |
| score | float | 可信度（1.0为可信度100%） |
| position | array | 当前字段在图像上的位置信息 |
| left | int | 位置值，距离原图左侧距离x，单位为像素 |
| top | int | 位置值，距离原图上方距离y，单位为像素 |
| width | int | 位置值，字段所在图框宽度w，单位为像素 |
| height | int | 位置值，字段所在图框高度h，单位为像素 |
| crop_img | string | 身份证切割图 |
| chinese_key | string | 该字段中文含义 |
| quad | string | 四个顶点坐标 |