# 名片识别 API 文档

# 接口说明

名片识别，通过OCR（光学字符识别 Optical Character Recognition）技术，对纸质名片进行识别，返回名片上的姓名、手机、电话、公司、部门、职位、传真、邮箱、网站、地址等关键信息，可以省去用户手动录入的过程，自动完成名片信息的结构化和数据的采集，可以很方便对接客户的后台数据系统，给用户带来极大的便利。该名片识别接口支持中文（简体和繁体）名片、英文、以及 16种小语种 名片，接口可以 自动识别名片语种，详见名片语种。

该能力是通过HTTP API的方式给开发者提供一个通用的接口，适用于一次性交互数据传输的AI服务场景，块式传输。相较于SDK，API具有轻量、跨语言的特点，不过请注意该接口使用的HTTP API协议不支持跨域。

# 接口Demo

示例demo请点击 这里 下载。
目前仅提供部分开发语言的demo，其他语言请参照下方接口文档进行开发。
也欢迎热心的开发者到 讯飞开放平台社区 分享你们的demo。

# 接口要求

集成名片识别API时，需按照以下要求。

# 接口调用流程

注： 若需配置IP白名单，请前往控制台。IP白名单规则请参照 IP白名单。

1. 通过接口密钥基于MD5计算签名，将签名以及其他参数放在Http Request Header中，详见下方 请求头 。
2. 将图片数据放在Http Request Body中，以POST表单的形式提交，详见下方 请求体 。
3. 向服务器端发送Http请求后，接收服务器端的返回结果，返回结果详见各接口的详细说明。

接口地址示例：

	POST http[s]://webapi.xfyun.cn/v1/service/v1/ocr/business_card 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 中配置以下参数。

# 授权认证

以下参数用于授权认证：

注：

• 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 串各字段说明如下：

X-Param生成示例：

	原始JSON串：
	{
	    "engine_type": "business_card"
	}
	BASE64编码（即X-Param）：
	eyJlbmdpbmVfdHlwZSI6ICJidXNpbmVzc19jYXJkIn0=

# 请求体

以POST表单的形式提交以下参数：

注： 1）一般基础类库会默认进行urlencode处理，请注意不要重复处理
2）base64编码后大小会增加约1/3

# 接口返回参数

返回值为json串，各字段如下：

其中sid字段主要用于追查问题，如果出现问题，可以提供sid给讯飞技术人员帮助确认问题。

data各字段说明如下：

每一个参数的赋值都是一个 JSON 的数组，数组包含了与这个键值相关的对象或字符串的值。对象含有两个键值：item 和 position。Item 的值是一个 JSON 对象或字符串。Position的值是一个字符串，表示这个属性在名片上的矩形位置。

示例如下：

失败：

    {
        "code": "10106",
        "desc": "invalid parameter|invalid X-Appid",
        "data": "",
        "sid": "wcr0000bb3f@ch3d5c059d83b3477200"
    }

成功

	{
	"biz_card_pic":"...the Base64 encoded pic data, too long to show....",
	"code": "0",
	"data": {
		"address": [{
			"item": {
				"country": "中国",
				"locality": "合肥",
				"street": "望江西路666号",
				"type": ["work"]
			},
			"position": "923,884,2373,884,2373,978,923,978"
		}],
		"email": [{
			"item": "lisi@iflytek.com",
			"position": "925,754,1809,754,1809,845,925,845"
		}],
		"formatted_name": [{
			"item": "李四",
			"position": "1687,1527,2074,1527,2074,1651,1687,1651"
		}],
		"label": [{
			"item": {
				"address": "安徽省合肥市高新区望江西路666号讯飞大厦",
				"type": ["work"]
			},
			"position": "923,884,2373,884,2373,978,923,978"
		}],
		"name": [{
			"item": {
				"family_name": "李",
				"given_name": "四"
			},
			"position": "0,0,0,0,0,0,0,0"
		}],
		"organization": [{
			"item": {
				"name": "科大讯飞股份有限公司"
			},
			"position": "686,1004,1809,1004,1809,1092,686,1092"
		}],
		"rotation_angle": "0",
		"telephone": [{
			"item": {
				"number": "18888888888",
				"type": ["cellular", "voice"]
			},
			"position": "3146,773,3757,773,3757,858,3146,858"
		}, {
			"item": {
				"number": "02155663009p8021",
				"type": ["work", "voice"]
			},
			"position": "2917,895,3746,895,3746,981,2917,981"
		}, {
			"item": {
				"number": "4006083063",
				"type": ["work", "voice"]
			},
			"position": "3114,648,3762,648,3762,736,3114,736"
		}],
		"title": [{
			"item": "技术支持经理",
			"position": "2129,1527,2607,1527,2607,1651,2129,1651"
		}],
		"url": [{
			"item": "www.iflytek.com",
			"position": "917,637,1586,637,1586,721,917,721"
		}]
	},
	"desc": "success",
	"sid": "wcr00000004@dx11730e797d37000100"
	}

# 名片语种

# 调用示例

名片识别demo go语言

名片识别demo php语言

名片识别demo python3语言

名片识别demo java语言

名片识别demo c#语言

名片识别demo nodejs语言

# 常见问题

# 名片识别的主要功能是什么？

答：基于行业领先的光学字符识别技术，将图片上的文字内容直接转化为可编辑文本。实现高精准，毫秒级识别体验。

# 名片识别支持什么哪些语言文字？

答：支持17种语言识别：英语、中文（简体）、中文（繁体）、日语、韩语、法语、西班牙语、葡萄牙语、德语、意大利语、荷兰语、希腊语、土耳其语、瑞典语、芬兰语、丹麦语、挪威语、匈牙利语

# 名片识别http post请求报10114无效checksum错误

答：webapi接口出于安全性考虑，每个请求中的 checkSum 有效期为 5 分钟(用 curTime 计算)，同时 curTime 要与标准时间同步，否则时间相差太大，服务端会直接认为 curTime 无效，从而报错10114。

# 名片识别经常性报10107错误

答：这个一般是由于图片不符合要求，比如名片所在图片中的位置偏移很大或者分辨率很低、图片过大超过大小限制，导致无法有效识别。

# 名片识别是否支持并发

答：webapi支持多并发。

# 名片识别套餐的收费价格是多少？怎么购买？

答：每个账号免费领取一次3000服务量有效期90天，套餐一:1w次服务量/840元/年，套餐二:10w次服务量/8000元/年，套餐三:100w次服务量/50000元/年，可在控制台对应服务--->实时用量--->购买服务量,套餐详细说明页。