营业执照识别 intsig API
POST
http[s]: //webapi.xfyun.cn/v1/service/v1/ocr/business_license接口说明
营业执照识别,通过 OCR(光学字符识别 Optical Character Recognition)技术,对营业执照图片进行识别,返回营业执照图片上的注册号、名称、类型、住所、法定代表人、注册资本、成立日期、营业期限和经营范围等信息,可以省去用户手动录入的过程,自动完成营业执照信息的结构化和图像数据的采集,可以很方便对接客户的后台数据系统,给用户带来极大的便利,方便用户保存。
该能力是通过HTTP API的方式给开发者提供一个通用的接口,适用于一次性交互数据传输的AI服务场景,块式传输。相较于SDK,API具有轻量、跨语言的特点,不过请注意该接口使用的HTTP API协议不支持跨域。
#接口Demo
示例demo请点击 这里 下载。
目前仅提供部分开发语言的demo,其他语言请参照下方接口文档进行开发。
也欢迎热心的开发者到 讯飞开放平台社区 分享你们的demo。
#接口要求
集成营业执照识别API时,需按照以下要求。
内容 | 说明 |
---|---|
请求协议 | http[s] (为提高安全性,强烈推荐https) |
请求地址 | http[s]: //webapi.xfyun.cn/v1/service/v1/ocr/business_license 注:服务器IP不固定,为保证您的接口稳定,请勿通过指定IP的方式调用接口,使用域名方式调用 |
请求方式 | POST |
接口鉴权 | 签名机制,见授权认证 |
字符编码 | UTF-8 |
响应格式 | 统一采用JSON格式 |
开发语言 | 任意,只要可以向讯飞云服务发起HTTP请求的均可 |
图片格式 | jpg/jpeg |
图片属性 | 建议最短边大于1200像素,图像质量75以上,位深度24 |
图片大小 | 图像数据按要求编码后(base64编码后进行urlencode)大小不超过4M |
#接口调用流程
注: 若需配置IP白名单,请前往控制台。IP白名单规则请参照 IP白名单。
- 通过接口密钥基于MD5计算签名,将签名以及其他参数放在Http Request Header中,详见下方 请求头 。
- 将图片数据放在Http Request Body中,以POST表单的形式提交,详见下方 请求体 。
- 向服务器端发送Http请求后,接收服务器端的返回结果,返回结果详见各接口的详细说明。
接口地址示例:
POST http[s]://webapi.xfyun.cn/v1/service/v1/ocr/business_license HTTP/1.1
Content-Type:application/x-www-form-urlencoded; charset=utf-8
#白名单
在调用该业务接口时
- 若关闭IP白名单,接口认为IP不限,不会校验IP。
- 若打开IP白名单,则服务端会检查调用方IP是否在讯飞开放平台配置的IP白名单中,对于没有配置到白名单中的IP发来的请求,服务端会拒绝服务。
IP白名单规则
- IP白名单,在 控制台-我的应用-相应服务的应用管理卡片上 编辑,保存后五分钟左右生效;
- 不同Appid的不同服务都需要分别设置IP白名单;
- IP白名单需设置为外网IP,请勿设置局域网IP;
- 如果服务器返回结果如下所示(illegal client_ip),则表示由于未配置IP白名单或配置有误,服务端拒绝服务。
{
"code":"10105",
"desc":"illegal access|illegal client_ip",
"data":"",
"sid":"xxxxxx"
}
#接口请求参数
#请求头
在 Http Request Header 中配置以下参数。
#授权认证
以下参数用于授权认证:
参数 | 格式 | 说明 | 必须 |
---|---|---|---|
X-Appid | string | 讯飞开放平台注册申请应用的应用ID(appid) | 是 |
X-CurTime | string | 当前UTC时间戳 从1970年1月1日0点0 分0 秒开始到现在的秒数 | 是 |
X-Param | string | 相关参数JSON串经Base64编码后的字符串,详见业务参数 | 是 |
X-CheckSum | string | 令牌,计算方法:MD5(APIKey + X-CurTime + X-Param),三个值拼接的字符串,进行MD5哈希计算(32位小写) | 是 |
注:
- APIKey:接口密钥,在讯飞开放平台控制台添加相应服务后即可获取,调用方注意保管,如泄露,可到控制台提交工单联系技术人员重置;
- X-CheckSum 有效期:出于安全性考虑,每个 X-CheckSum 的有效期为 5 分钟(用 X-CurTime 计算),同时 X-CurTime 要与标准时间同步,否则时间相差太大,服务端会直接认为 X-CurTime 无效;
- BASE64 编码采用 MIME 格式,字符包括大小写字母各26个,加上10个数字,和加号 + ,斜杠 / ,一共64个字符。
X-CheckSum生成示例:
String APIKey="abcd1234";
String X-CurTime="1502607694";
String X-Param="eyAiYXVmIjogImF1ZGlvL0wxNjtyYXR...";
String X-CheckSum=MD5(apiKey + X-CurTime + X-Param);
#业务参数
X-Param 为各配置参数组成的 JSON 串经 BASE64 编码之后的字符串,原始 JSON 串各字段说明如下:
参数 | 类型 | 必须 | 说明 | 示例 |
---|---|---|---|---|
engine_type | string | 是 | 引擎类型,固定为business_license | business_license |
imei | string | 否 | 手机序列号 | 12345678 |
osid | string | 否 | 操作系统版本 | Android |
ua | string | 否 | 厂商|全称|机型信息|操作系统版本|分辨率 | vivo|vivoY67L|PD1612|ANDROID6.0|720*1280 |
X-Param生成示例:
原始JSON串:
{
"engine_type": "business_license",
}
BASE64编码(即X-Param):
eyJlbmdpbmVfdHlwZSI6ICJidXNpbmVzc19saWNlbnNlIn0=
#请求体
以POST表单的形式提交以下参数:
参数 | 类型 | 必须 | 说明 | 示例 |
---|---|---|---|---|
image | string | 是 | 图像数据 base64编码后进行urlencode 要求base64编码和urlencode后大小不超过4M 仅支持jpg格式 推荐 jpg 文件设置为:最短边大于 1200 像素,图像质量 75 以上,位深度 24。 | exSI6ICJ... |
注: 1)一般基础类库会默认进行urlencode处理,请注意不要重复处理
2)base64编码后大小会增加约1/3
其中的error_msg和error_code的取值范围及说明对照表:
error_code | error_msg | 说明 |
---|---|---|
0 | ok | 正常返回 |
40001 | invalid parameter | 参数不对 |
40002 | missing parameter | 缺少参数 |
40003 | invalid user or password | 账号或密码不对 |
40004 | missing request body | 没有HTTP body |
40005 | invalid image format | HTTP body不是图像或者不支持该格式 |
40006 | invalid image size | 图片太大或太小 |
40007 | fail to recognize | 识别失败 |
40008 | invalid content type | 通过HTTP form上传图片时,Content-Type无效 |
40009 | corrupted request body | 请求body损坏 |
40010 | fail to extract image | 提取图像裸数据失败 |
50001 | backend down | 后台服务器宕机 |
50004 | timeout | 识别超时 |
90099 | unknown | 未知错误 |
调用示例
注: demo只是一个简单的调用示例,不适合直接放在复杂多变的生产环境使用
#常见问题
#营业执照识别主要功能是什么?
答:基于行业领先的光学字符识别技术,将图片上的文字内容直接转化为可编辑文本。实现高精准,毫秒级识别体验。
#上传营业执照复印件的图片有时候加盖公章会影响识别效果
答:上传的公章带有红色印记有时候会覆盖营业执照上的字体信息,所以待识别的图片尽量保持执照内部字体清晰可见,否则影响识别。
#营业执照图片大小最大支持多少
答:图像数据base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,仅支持jpg格式,推荐 jpg 文件设置为:最短边大于 1200 像素,图像质量 75 以上,位深度 24。
#营业执照识别的收费价格是多少?怎么购买?
答:每个账号免费领取一次3000服务量有效期90天,套餐一:1w次服务量/240元/年,套餐二:10w次服务量/2000元/年,套餐三:100w次服务量/16000元/年,可在控制台对应服务--->实时用量--->购买服务量,套餐详细说明页 。
请求参数
示例代码
返回响应
住所/经营场所/主要经营场所/营业场所
类型/公司类型/主体类型
法定代表人/负责人/经营者/经营者姓名
{
"code": "0",
"data": {
"biz_license_address": "合肥市高新区XXX号",
"biz_license_company_name": "XXX公司",
"biz_license_company_type": "股份有限公司",
"biz_license_credit_code": "11111122222000000W",
"biz_license_operating_period": "2010年12月06日至XXX",
"biz_license_owner_name": "XXX",
"biz_license_reg_capital": "贰佰万元整",
"biz_license_scope": "商务信息咨询,计算机网络技术开发技术咨询及技术服务,会议及展览服务,计算机软件开发,销售。 (以上经营范围法律,法规禁止经营的,不得经营;法律,法规,国务院规定需经审批的,未获审批前,不得经营。)",
"biz_license_start_time": "2010年12月06日",
"error_code": 0,
"error_msg": "ok",
"type": "营业执照"
},
"desc": "success",
"sid": "wcr00000005@dx11730e7981af000100"
}