营业执照OCR识别
传入营业执照图片或url地址,识别营业执照基本信息
官网购买的套餐通过API调用时请使用“扣套餐次数”密钥进行调用
请求地址
POSThttps://api.shuxuntech.com/v1/business/ocr
¥0.05元 / 次
阶梯计价,用量越大单价越低
企业认证后额外赠送 666 次调用额度
01 — 接口说明
请求参数与返回结果
所有请求需在 header 中携带签名信息,body 参数按 x-www-form-urlencoded 提交
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| appKey | head | string | 是 | 数勋分配appKey |
| timestamp | head | string | 是 | unix时间毫秒值 |
| sign | head | string | 是 | 签名,说明 |
| image | body | string | 否 | 营业执照照片base64,不超过1mb |
| imgUrl | body | string | 否 | 营业执照图片url,不超过1mb |
签名算法说明
数勋分配的appKey、当前unix时间毫秒值timestamp、数勋分配的appSecret、 按顺序拼接sha256加密得到sign,查看如下示例
appKey = aaa;timestamp = 1682476904289;appSecret = bbb;sign = sha256(appKey+timestamp+appSecret)02 — 返回说明
返回结构与字段含义
顶层返回 code 与 msg,业务数据在 data 对象内,各字段含义见下方表格
返回字段描述
| 字段名 | 类型 | 描述 |
|---|---|---|
| code | string | 错误码 |
| msg | string | 错误描述 |
| isFee | int | 是否计费(1:计费,0:不计费) |
| seqNo | string | 调用流水号 |
| data | object | 返回数据 |
data对象说明
| 字段名 | 类型 | 描述 |
|---|---|---|
| result | int | 识别结果 |
| resultDesc | string | 识别结果描述 |
| info | object | 营业执照信息 |
info对象说明
| 字段名 | 类型 | 描述 |
|---|---|---|
| enterpriseType | string | 企业类型 |
| address | string | 地址 |
| registrationCapital | string | 注册资本 |
| opTo | string | 经营结束日期 |
| orgForm | string | 组成形式 |
| opScope | string | 经营范围 |
| establishingDate | string | 成立时间 |
| legalName | string | 企业法人 |
| registrationCode | string | 注册号 |
| opFrom | string | 经营开始日期 |
| creditCode | string | 统一社会信用代码 |
| opPeriod | string | 经营日期开始至结束时间 |
| enterpriseName | string | 企业名称 |
| isCopy | int | 是否为副本, 1:是 0:否 |
result扫描结果说明
| 字段名 | 类型 | 描述 |
|---|---|---|
| 1 | 识别成功,有数据 | |
| 2 | 识别成功,无数据 | |
| 3 | 识别失败,无法正确解析、未按要求传入参数、下载图片超时 |
code错误码说明
| code | 说明 |
|---|---|
| 0 | 成功 |
| 1 | 参数错误 |
| 2 | 无记录 |
| 3 | 第三方服务异常 |
| 4 | 签名错误 |
| 5 | 余额不足 |
| 6 | 调用频率超限 |
| 7 | 账号停用 |
| 8 | 接口已停用 |
| 9 | 联系服务商开通接口权限 |
| 10 | ip不在白名单 |
| 11 | 系统异常 |
| 12 | 实名状态错误 |
| 99 | 其他异常,具体返回为准 |
返回示例
正确返回
{ "code": "0", "msg": "成功", "isFee": 1, "seqNo": "98ik48a942udag92uxvhz1jw2txplza9", "data": { "result": 1, "resultDesc": "识别成功,有数据", "info": { "enterpriseType": "有限责任公司(自然人投资或控股)", "address": "北京市**区西二旗***3号院**号***号", "registrationCapital": "185,000万(元)", "opTo": "", "orgForm": "", "opScope": "一般项目:技术服务、技术开发、技术咨询、技术交流、技术转让、技术推广;货物进出口;技术进出口;进出口代理;通讯设备销售;厨具卫具及日用杂品批发;厨具卫具及日用杂品零售;个人卫生用品销售;卫生用品和一次性使用医疗用品销售;日用杂品销售;日用百货销售;日用品销售;化妆品批发;化妆品零售;第一类医疗器械销售;第二类医疗器械销售;玩具销售;体育用品及器材零售;体育用品及器材批发;文具用品零售;文具用品批发;鞋帽批发;鞋帽零售;服装服饰批发;服装服饰零售;钟表销售;眼镜销售(不含隐形眼镜);针纺织品销售;家用电器销售;日用家电零售;家具销售;礼品花卉销售;农作物种子经营(仅限不再分装的包装种子);照相机及器材销售;照相器材及望远镜批发;照相器材及望远镜零售;工艺美术品及收藏品零售(象牙及其制品除外);工艺美术品及礼仪用品销售(象牙及其制品除外);计算机软硬件及辅助设备零售;计算机软硬件及辅助设备批发;珠宝首饰零售;珠宝首饰批发;食用农产品批发;食用农产品零售;宠物食品及用品批发;宠物食品及用品零售;电子产品销售;摩托车及零配件零售;摩托车及零配件批发;电动自行车销售;助动自行车、代步车及零配件销售;自行车及零配件零售;自行车及零配件批发;单用途商业预付卡代理销售;商用密码产品销售;五金产品批发;五金产品零售;建筑材料销售;仪器仪表修理;计算机及办公设备维修;办公设备销售;会议及展览服务;组织文化艺术交流活动;广告设计、代理;广告制作;广告发布;摄影扩印服务;票务代理服务;通讯设备修理;移动终端设备制造;可穿戴智能设备制造。(除依法须经批准的项目外,凭营业执照依法自主开展经营活动)许可项目:第三类医疗器械经营;网络文化经营;出版物零售;出版物批发;食品销售;药品零售;广播电视节目制作经营;第一类增值电信业务;第二类增值电信业务;在线数据处理与交易处理业务(经营类电子商务);基础电信业务;互联网信息服务;信息网络传播视听节目。(依法须经批准的项目,经相关部门批准后方可开展经营活动,具体经营项目以相关部门批准文件或许可证件为准)(不得从事国家和本市产业政策禁止和限制类项目的经营活动。)", "establishingDate": "2010-03-03", "legalName": "***", "registrationCode": "", "opFrom": "", "creditCode": "9111010855***082Q", "opPeriod": "", "enterpriseName": "***科技有限责任公司", "isCopy": 1 } }}错误返回
{ "code": "1", "msg": "参数错误", "isFee": 0, "seqNo": null, "data": null}03 — 代码示例
七种语言,复制即用
签名规则:sha256(appKey + timestamp + appSecret),下列示例已包含完整签名流程
BusinessOcrDemo.java
import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;
import java.security.MessageDigest;
/**
* 营业执照OCR - Java 示例代码
* 接口地址:https://api.shuxuntech.com/v1/business/ocr
*
* 说明:本示例只使用 JDK 原生 API(java.net / java.security),不依赖任何第三方 jar 包,
* 也不需要本项目的工具类,复制到本地即可编译运行:
* javac BusinessOcrDemo.java
* java BusinessOcrDemo
*/
public class BusinessOcrDemo {
/** 数勋分配的 appKey,请替换为您自己的 appKey */
private static final String APP_KEY = "您的appKey";
/** 数勋分配的 appSecret,请替换为您自己的 appSecret */
private static final String APP_SECRET = "您的appSecret";
/** 接口地址 */
private static final String API_URL = "https://api.shuxuntech.com/v1/business/ocr";
/** 图片base64 */
private static final String IMAGE = "";
/** 图片url */
private static final String IMG_URL = "";
public static void main(String[] args) throws Exception {
// 1、当前 unix 时间毫秒值,服务端要求与服务器时间相差不能超过 5 分钟
String timestamp = String.valueOf(System.currentTimeMillis());
// 2、签名:按顺序拼接 appKey + timestamp + appSecret 后做 sha256,得到小写十六进制字符串
String sign = sha256Hex(APP_KEY + timestamp + APP_SECRET);
// 3、业务参数,拼成表单内容
String body = "image=" + urlEncode(IMAGE) + "&" + "imgUrl=" + urlEncode(IMG_URL);
// 4、发起 POST 请求,appKey、timestamp、sign 放在请求头
HttpURLConnection conn = (HttpURLConnection) new URL(API_URL).openConnection();
conn.setRequestMethod("POST");
conn.setDoOutput(true);
conn.setRequestProperty("Content-Type", "application/x-www-form-urlencoded; charset=UTF-8");
conn.setRequestProperty("appKey", APP_KEY);
conn.setRequestProperty("timestamp", timestamp);
conn.setRequestProperty("sign", sign);
conn.setConnectTimeout(10000);
conn.setReadTimeout(20000);
conn.getOutputStream().write(body.getBytes("UTF-8"));
int status = conn.getResponseCode();
// 5、读取返回内容:报错时读错误流,避免只拿到一个异常看不到原因
InputStream in = (status >= 200 && status < 300) ? conn.getInputStream() : conn.getErrorStream();
String result = readAll(in);
conn.disconnect();
System.out.println("HTTP状态码=" + status);
System.out.println("返回结果=" + result);
}
/**
* sha256 加密,返回小写十六进制字符串
* 服务端校验签名用的就是这个算法(小写十六进制)
*/
private static String sha256Hex(String content) throws Exception {
byte[] bytes = MessageDigest.getInstance("SHA-256").digest(content.getBytes("UTF-8"));
StringBuilder sb = new StringBuilder(bytes.length * 2);
for (byte b : bytes) {
sb.append(Character.forDigit((b >> 4) & 0xF, 16));
sb.append(Character.forDigit(b & 0xF, 16));
}
return sb.toString();
}
/** url 编码,中文参数需要编码 */
private static String urlEncode(String value) throws Exception {
return URLEncoder.encode(value, "UTF-8");
}
/** 读取输入流内容 */
private static String readAll(InputStream in) throws Exception {
if (in == null) {
return "";
}
StringBuilder sb = new StringBuilder();
BufferedReader reader = new BufferedReader(new InputStreamReader(in, "UTF-8"));
try {
String line;
while ((line = reader.readLine()) != null) {
sb.append(line);
}
} finally {
reader.close();
}
return sb.toString();
}
}04 — 在线调试
先调通,再决定
用你自己的数据发一次真实请求,表单字段随接口定义自动生成,返回结果附字段注释
POSThttps://api.shuxuntech.com/v1/business/ocr按次计费 · 优先扣套餐次数
请求参数
按接口定义自动生成
- image营业执照照片base64,不超过1mb
- imgUrl营业执照图片url,不超过1mb
appKey / timestamp / sign调用时自动按 sha256 生成,无需手填
appKey=未获取 · timestamp=实时生成 · sign=自动生成
这是真实调用,会消耗套餐次数或账户余额; 请勿用真实证件信息反复试调
调不通时先看这里错误码与返回字段的完整说明见上方「02 — 返回说明」;签名口径与「03 — 代码示例」完全一致,可直接复制使用。
返回结果
点击左侧「提交并调用接口」,参数会就地组装、按文档口径签名后直接请求接口, 返回的 JSON 显示在这里。
在线调试使用你自己的 appKey,按实际调用计费。
返回结果是纯 JSON,字段含义见上方「02 — 返回说明」字段类型与取值说明以「02 — 返回说明」的字段表为准;错误码的完整定义同样在那一节。
05 — 产品价格
阶梯计价,用多少买多少
单次价格随调用量阶梯下降,大档位单价最低
| 调用量 | 价格 | 单价 |
|---|---|---|
| 20 次 | ¥ 0 | ¥ 0 |
| 100 次 | ¥ 15 | ¥ 0.15 |
| 1,000 次 | ¥ 120 | ¥ 0.12 |
| 5,000 次 | ¥ 450 | ¥ 0.09 |
| 10,000 次 | ¥ 800 | ¥ 0.08 |
| 50,000 次 | ¥ 3,500 | ¥ 0.07 |
| 100,000 次 | ¥ 6,000 | ¥ 0.06 |
| 500,000 次 | ¥ 25,000 | ¥ 0.05 |