1.接口说明
发票OCR(API)定义:传入发票图像,精准识别发票文字信息,返回包括标题、发票号码、开票日期、项目名称、金额、税额、价税合计、代码、发票号码、开票日期、密码区、纳税人识别号、地址、电话、开户行及账号、开票人、复核、收款人、备注等数十个字段。
1.1主要功能
发票OCR接口支持URL/Base64输入,识别并返回发票关键信息及项目明细。其主要功能包括:
- 多类型覆盖:
- 支持模糊、光照不均、透视畸变、复杂背景等低质量图像识别。
- 实时性高:
- 提供弹性伸缩的低延时服务。
- 服务稳定:
- 提供弹性服务,扩展性好,算法迭代优化对稳定性无影响。
- 超高精度及性能:
- 识别准确率高,识别速度快,响应及时。
1.2接入场景
支持各种程序和设备接入,包括小程序、APP、采集设备等,灵活适用于不同应用场景。
2.请求信息
2.1请求地址(URL)
POST http(s)://ocr-api.shiliuai.com/api/invoice_ocr/v1
2.2请求方式
POST
2.3请求头(header)
| 参数 | 类型 | 说明 |
|---|---|---|
| Content-Type | string | application/json |
| Authorization | string | 'APPCODE ' + 您的AppCode(注意英文空格) |
| 参数 | 类型 | 说明 |
|---|---|---|
| Content-Type | string | application/json |
| x-ca-key | string | 您的AppKey |
| x-ca-timestamp | string | 时间戳(毫秒) |
| x-ca-signature | string | 签名sign |
签名方法:
str = app_key×tamp&app_secret sign = md5(str)
2.4请求体(body)
| 参数 | 是否必填 | 类型 | 说明 |
|---|---|---|---|
| file_base64 | 选填 | string | base64编码的图片或pdf文件,file_base64与file_url必须传一个。像素范围:[15,8192],小于20M |
| file_url | 选填 | string | 图片或pdf文件的url,file_base64与file_url必须传一个。像素范围:[15,8192],小于20M |
3.返回信息
3.1返回类型
JSON
3.2返回码
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 返回码,0表示成功 |
| message | string | 返回信息 |
3.3返回信息
| 参数 | 类型 | 说明 |
|---|---|---|
| code | int | 错误码 |
| msg | string | 错误信息(英文) |
| msg_cn | string | 错误信息(中文) |
| success | bool | 识别是否成功 |
| file_id | string | 唯一文件ID |
| request_id | string | 唯一请求ID |
| data | data, 具体看下面 | 具体看下面 |
| page_no | int | content 内单张发票的页码(从1开始,指示该结果所在的文件页) |
3.4返回示例
{
'code': 200,
'msg': 'OK',
'msg_cn': '成功',
'success': True,
'file_id': file id,
'request_id': request id,
'data': data
}
data = {
"n": 发票数量,
"content": [
{
"标题": "浙江增值税电子普通发票",// 以下格式均为string
"发票号码": "12345678",
"开票日期": "2023-05-18",
"购买方名称": "低价买入有限责任公司",
"销售方名称": "高价卖出有限责任公司",
"购买方纳税人识别号": "440123456789451",
"销售方纳税人识别号": "550123456789451",
"购买方地址电话": "翻斗大街翻斗花园2号楼1001室-12345678911",
"销售方地址电话": "翻斗大街翻斗花园2号楼1101室-98745612326",
"购买方开户行及账号": "努力存钱A大银行",
"销售方开户行及账号": "努力存钱B大银行",
"大写金额": "捌拾玖万肆仟伍佰陆拾壹",
"小写金额": "894561.00",
"项目": [
{
"项目名称": "糊涂兔笔记本",
"规格型号": "糊涂兔",
"单位": "台",
"数量": "88",
"单价": "3888",
"金额": "342144",
"税率": "17%",
"税额": "58164.48"
}
],
"开票人": "张三",
"收款人": "李四",
"复核人": "王五",
"page_no": 1 // int, 该内容在文件的第几页(从1开始)
}
]
}
3.5错误码
| 错误码 | 说明 |
|---|---|
| 200 | 成功 |
| 400 | 错误请求,比如参数错误 |
| 401 | 未经授权 |
| 403 | 禁止访问 |
| 429 | 请求过多 |
| 500 | 内部错误 |
4.示例代码
4.1 Python
# -*- coding: utf-8 -*-
import requests
import base64
import json
# 请求接口
URL = "https://ocr-api.shiliuai.com/api/invoice_ocr/v1"
# 图片转base64
def get_base64(file_path):
with open(file_path, 'rb') as f:
data = f.read()
b64 = base64.b64encode(data).decode('utf8')
return b64
def demo(appcode, file_path):
# 请求头
headers = {
'Authorization': 'APPCODE %s' % appcode,
'Content-Type': 'application/json'
}
# 请求体
b64 = get_base64(file_path)
data = {"file_base64": b64}
# 请求
response = requests.post(url=URL, headers=headers, json=data)
content = json.loads(response.content)
print(content)
if __name__=="__main__":
appcode = "你的APPCODE"
file_path = "本地文件路径"
demo(appcode, file_path)
import requests
import base64
import json
import hashlib
import time
# 请求接口
URL = "https://ocr-api.shiliuai.com/api/invoice_ocr/v1"
# 图片转base64
def get_base64(file_path):
with open(file_path, 'rb') as f:
data = f.read()
b64 = base64.b64encode(data).decode('utf8')
return b64
def md5(s):
return hashlib.md5(s.encode("utf8")).hexdigest()
def demo(app_key, app_secret, file_path):
# 请求头
t = int(time.time() * 1000)
s = "%s&%s&%s" % (app_key, t, app_secret)
sign = md5(s)
headers = {
'x-ca-key': app_key,
'x-ca-timestamp': t,
'x-ca-signature': sign,
'Content-Type': 'application/json'
}
# 请求体
b64 = get_base64(file_path)
data = {"file_base64": b64}
# 请求
response = requests.post(url=URL, headers=headers, json=data)
content = json.loads(response.content)
print(content)
if __name__=="__main__":
app_key = "你的APP_KEY"
app_secret = "你的APP_SECRET"
file_path = "本地图片路径"
demo(app_key, app_secret, file_path)
4.2 PHP
//图片转base64
function get_base64($path){
if($fp = fopen($path, "rb", 0)) {
$binary = fread($fp, filesize($path));// 文件读取
fclose($fp);
$b64 = base64_encode($binary);// 转base64
}else{
$b64="";
printf("%s 文件不存在", $path);
}
return $b64;
}
$url = "https://ocr-api.shiliuai.com/api/invoice_ocr/v1";
$appcode = "你的appcode";
$file_path = "文件路径";
$method = "POST";
// 请求头
$headers = array();
array_push($headers, "Authorization:APPCODE " . $appcode);
array_push($headers, "Content-Type:application/json");
// 请求体
$b64 = get_base64($file_path);
$data = array(
"file_base64" => $b64
);
$post_data = json_encode($data);
// 请求
$curl = curl_init();
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_FAILONERROR, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HEADER, true);
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($curl, CURLOPT_POSTFIELDS, $post_data);
$result = curl_exec($curl);
var_dump($result);
function get_base64($path){
if($fp = fopen($path, "rb", 0)) {
$binary = fread($fp, filesize($path));// 文件读取
fclose($fp);
$b64 = base64_encode($binary);// 转base64
}else{
$b64="";
printf("%s 文件不存在", $path);
}
return $b64;
}
$url = "https://ocr-api.shiliuai.com/api/invoice_ocr/v1";
$file_path = "文件路径";
$method = "POST";
//请求头
$app_key = "你的app_key";
$app_secret = "你的app_secret";
$timestamp=time();
$sign_string = $app_key . "&" . $timestamp . "&" . $app_secret;
$sign = md5($sign_string);
$headers = array();
array_push($headers, "Content-Type:application/json");
array_push($headers, "x-ca-key:" . $app_key);
array_push($headers, "x-ca-timestamp:" . $timestamp);
array_push($headers, "x-ca-signature:" . $sign);
// 请求体
$b64 = get_base64($file_path);
$data = array(
"file_base64" => $b64
);
$post_data = json_encode($data);
// 请求
$curl = curl_init();
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_FAILONERROR, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HEADER, true);
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($curl, CURLOPT_POSTFIELDS, $post_data);
$result = curl_exec($curl);
var_dump($result);
4.3 Java
import com.alibaba.fastjson2.JSON;
import com.alibaba.fastjson2.JSONObject;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
import org.apache.commons.io.FileUtils;
import java.io.File;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import java.util.Base64;
public class Main {
public static String get_base64(String path) {
String b64 = "";
try {
// 使用Commons IO简化文件读取
byte[] content = FileUtils.readFileToByteArray(new File(path));
// 使用JDK自带的Base64
b64 = Base64.getEncoder().encodeToString(content);
} catch (IOException e) {
e.printStackTrace();
}
return b64;
}
public static void main(String[] args) {
String url = "https://ocr-api.shiliuai.com/api/invoice_ocr/v1";// 请求接口
String appcode = "你的APPCODE";
String file_path = "本地文件路径";
Map headers = new HashMap<>();
headers.put("Authorization", "APPCODE " + appcode);
headers.put("Content-Type", "application/json");
// 请求体
requestObj = new JSONObject();
requestObj.put("file_base64", get_base64(file_path));
String bodys = requestObj.toString();
try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
HttpPost httpPost = new HttpPost(url);
for (Map.Entry entry : headers.entrySet()) {
httpPost.addHeader(entry.getKey(), entry.getValue());
}
StringEntity entity = new StringEntity(bodys, "UTF-8");
httpPost.setEntity(entity);
HttpResponse response = httpClient.execute(httpPost);
int stat = response.getStatusLine().getStatusCode();
if (stat != 200) {
System.out.println("Http code: " + stat);
return;
}
String res = EntityUtils.toString(response.getEntity());
JSONObject res_obj = JSON.parseObject(res);
System.out.println(res_obj.toJSONString());
} catch (Exception e) {
e.printStackTrace();
}
}
}
import com.alibaba.fastjson2.JSON;
import com.alibaba.fastjson2.JSONObject;
import org.apache.commons.io.FileUtils;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
import java.io.File;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import java.util.Base64;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
public class Demo {
public static String get_base64(String path) {
String b64 = "";
try {
File file = new File(path);
if (!file.exists()) {
System.err.println("文件不存在: " + path);
return b64;
}
byte[] content = FileUtils.readFileToByteArray(file);
b64 = Base64.getEncoder().encodeToString(content);
} catch (IOException e) {
System.err.println("读取文件失败: " + e.getMessage());
e.printStackTrace();
}
return b64;
}
public static String MD5(String input) {
try {
MessageDigest md = MessageDigest.getInstance("MD5");
byte[] messageDigest = md.digest(input.getBytes());
StringBuilder hexString = new StringBuilder();
for (byte b : messageDigest) {
String hex = Integer.toHexString(0xff & b);
if (hex.length() == 1) hexString.append('0');
hexString.append(hex);
}
return hexString.toString();
} catch (NoSuchAlgorithmException e) {
e.printStackTrace();
}
return null;
}
public static void main(String[] args) {
String url = "https://ocr-api.shiliuai.com/api/invoice_ocr/v1";// 请求接口
String file_path = "本地文件路径";
String app_key = "你的APPKEY";
String app_secret = "你的APPSECRET";
String timestamp = System.currentTimeMillis() + "";
String sign = MD5(app_key + "&" + timestamp + "&" + app_secret);
Map headers = new HashMap<>();
headers.put("Content-Type", "application/json");
headers.put("x-ca-key", app_key);
headers.put("x-ca-timestamp", timestamp);
headers.put("x-ca-signature", sign);
JSONObject requestObj = new JSONObject();
requestObj.put("file_base64", get_base64(file_path));
String bodys = requestObj.toString();
try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
HttpPost httpPost = new HttpPost(url);
for (Map.Entry entry : headers.entrySet()) {
httpPost.addHeader(entry.getKey(), entry.getValue());
}
StringEntity entity = new StringEntity(bodys, "UTF-8");
httpPost.setEntity(entity);
HttpResponse response = httpClient.execute(httpPost);
int stat = response.getStatusLine().getStatusCode();
if (stat != 200) {
System.out.println("Http code: " + stat);
System.out.println("Http " + EntityUtils.toString(response.getEntity()));
return;
}
String res = EntityUtils.toString(response.getEntity());
JSONObject res_obj = JSON.parseObject(res);
System.out.println(res_obj.toJSONString());
} catch (Exception e) {
e.printStackTrace();
}
}
}
4.4 C#
using System.Text;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
namespace MyCSharpApp
{
public class Program
{
public static string GetBase64(string path)
{
string b64 = "";
try
{
// 读取文件内容
byte[] content = File.ReadAllBytes(path);
// 转换为Base64字符串
b64 = Convert.ToBase64String(content);
}
catch (Exception e)
{
Console.WriteLine(e.Message);
}
return b64;
}
public static async Task Main(string[] args)
{
string url = "https://ocr-api.shiliuai.com/api/invoice_ocr/v1";// 请求接口
string appcode = "你的APPCODE";
string file_path = "本地文件路径";
// 设置请求头
Dictionary headers = new Dictionary
{
{ "Authorization", "APPCODE " + appcode }
// Content-Type 将在创建 StringContent 时设置
};
// 请求体
JObject requestObj = new JObject();
requestObj["file_base64"] = GetBase64(file_path);
string body = requestObj.ToString();
try
{
using (HttpClient client = new HttpClient())
{
// 设置请求头
foreach (var header in headers)
{
client.DefaultRequestHeaders.Add(header.Key, header.Value);
}
// 创建请求内容
StringContent content = new StringContent(body, Encoding.UTF8, "application/json");
// 发送请求并获取响应
HttpResponseMessage response = await client.PostAsync(url, content);
if (!response.IsSuccessStatusCode)
{
Console.WriteLine($"Http code: {(int)response.StatusCode}");
return;
}
// 读取响应内容
string responseContent = await response.Content.ReadAsStringAsync();
JObject resObj = JObject.Parse(responseContent);
Console.WriteLine(resObj.ToString(Formatting.Indented));
}
}
catch (Exception e)
{
Console.WriteLine(e.Message);
}
}
}
}
using System.Security.Cryptography;
using System.Text;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
namespace MyCSharpApp
{
public class Program
{
public static string GetBase64(string path)
{
string b64 = "";
try
{
// 读取文件内容
byte[] content = File.ReadAllBytes(path);
// 转换为Base64字符串
b64 = Convert.ToBase64String(content);
}
catch (Exception e)
{
Console.Error.WriteLine("读取文件失败: " + e.Message);
}
return b64;
}
public static string CalculateMD5(string input)
{
try
{
// 创建MD5哈希提供程序
using (MD5 md5 = MD5.Create())
{
// 计算输入字符串的哈希值
byte[] inputBytes = Encoding.UTF8.GetBytes(input);
byte[] hashBytes = md5.ComputeHash(inputBytes);
// 将字节数组转换为十六进制字符串
StringBuilder sb = new StringBuilder();
for (int i = 0; i < hashBytes.Length; i++)
{
sb.Append(hashBytes[i].ToString("x2"));
}
return sb.ToString();
}
}
catch (Exception e)
{
Console.WriteLine(e.Message);
return string.Empty;
}
}
public static async Task Main(string[] args)
{
string url = "https://ocr-api.shiliuai.com/api/invoice_ocr/v1";// 请求接口
string file_path = "本地文件路径";
string app_key = "你的APPKEY";
string app_secret = "你的APPSECRET";
string timestamp = DateTimeOffset.Now.ToUnixTimeMilliseconds().ToString();
string sign = CalculateMD5(app_key + "&" + timestamp + "&" + app_secret);
// 设置请求头
Dictionary headers = new Dictionary
{
{ "x-ca-key", app_key },
{ "x-ca-timestamp", timestamp },
{ "x-ca-signature", sign }
};
// 请求体
JObject requestObj = new JObject();
requestObj["file_base64"] = GetBase64(file_path);
string body = requestObj.ToString();
try
{
using (HttpClient client = new HttpClient())
{
// 设置请求头
foreach (var header in headers)
{
client.DefaultRequestHeaders.Add(header.Key, header.Value);
}
// 创建请求内容
StringContent content = new StringContent(body, Encoding.UTF8, "application/json");
// 发送请求并获取响应
HttpResponseMessage response = await client.PostAsync(url, content);
if (!response.IsSuccessStatusCode)
{
Console.WriteLine($"Http code: {(int)response.StatusCode}");
Console.WriteLine($"Http {await response.Content.ReadAsStringAsync()}");
return;
}
// 读取响应内容
string responseContent = await response.Content.ReadAsStringAsync();
JObject resObj = JObject.Parse(responseContent);
Console.WriteLine(resObj.ToString(Formatting.Indented));
}
}
catch (Exception e)
{
Console.WriteLine(e.Message);
}
}
}
}