海关报关单识别
接口描述
用户通过发送HTTP Post请求方式提交数据至公有云服务器,服务器识别并返回json格式的识别结果。
接口说明
请求URL:http://api.exocr.com/ocr/v1/custom_form
请求方式:HTTP Post
返回格式:json
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/custom_form";
//设置请求参数
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/bankcard.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": {
"bank_name": {
"words": "交通银行(301290000007)",
"score": 1,
"position": {
"left": 0,
"top": 0,
"width": 0,
"height": 0
}
},
"card_name": {
"words": "太平洋人民币贷记卡",
"score": 1,
"position": {
"left": 0,
"top": 0,
"width": 0,
"height": 0
}
},
"card_type": {
"words": "贷记卡",
"score": 1,
"position": {
"left": 0,
"top": 0,
"width": 0,
"height": 0
}
},
"valid_thru": {
"words": "0/0",
"score": 1,
"position": {
"left": 0,
"top": 0,
"width": 0,
"height": 0
}
},
"card_no": {
"words": "#######",
"score": 1,
"position": {
"left": 0,
"top": 0,
"width": 0,
"height": 0
}
},
"returned_image": ""
},
"error_code": 0,
"description": "识别成功",
"request_id": "41E6419E411D41A5A8918DA2E5E5FEB2",
"recognize_time": 1713,
"available_count": 9927
}
返回说明
通用参数
参数 | 类型 | 说明 |
---|---|---|
result | array | 返回结果数组,包括所有识别信息 |
error_code | int | 错误码,返回0为正确,其他为错误 |
description | string | 识别结果描述 |
request_id | string | 请求唯一标识符 |
recognize_time | int | 识别所用时间,单位为毫秒 |
available_count | int | 识别剩余可用次数,次数不足时无法继续识别,可在控制台进行充值次数 |
result特有参数
参数 | 类型 | 说明 |
---|---|---|
commodity_list | List | 商品清单 |
item_no | String | 项号 |
commodity_no | String | 商品编号 |
commodity_name | String | 商品名称及规格型号 |
amount_unit | String | 数量及单位 |
price_total | String | 单价/总价/币值 |
orign_nation | String | 原产国(地区) |
dest_nation | String | 最终目的国(地区) |
domestic_dest | String | 境内目的地 |
tax_free | String | 征免 |