功能描述

多语言名片结构化，返回名片的信息以及切图

请求URL

https://api.textin.com/robot/v1.0/api/business_card

HTTP请求方法

HTTP POST

请求头说明（Request Header）

请在HTTP请求中添加以下自定义Header。

header 名	值
x-ti-app-id	请登录后前往 “工作台-账号设置-开发者信息” 查看 x-ti-app-id
x-ti-secret-code	请登录后前往 “工作台-账号设置-开发者信息” 查看 x-ti-secret-code

URL参数（Parameters）

URL参数指以 {参数名}={参数值} 形式拼接到 URL 上的键值对。它以 ? 开头，不同参数之间使用 & 连接。形如 ?p1=v1&p2=v2

参数名	数据类型	是否必填	允许的值	描述
ori_position	integer	否	1, 0	如果为1，返回结果中position字段坐标对应原图的而非旋转转正的图片。如果为0，position字段坐标对应转正后的图片。
crop_image	integer	否	1, 0	是否返回切图， 0为不返回切图，1为返回切图，默认为1

请求体说明（Request Body）

Content-Type: application/octet-stream

要上传的图片，目前支持jpg, png, bmp, pdf, tiff, 单帧gif等大部分格式.

请注意，请求体的数据格式为文件的二进制流，非 FormData 或其他格式。文件大小不超过 10M，图像宽高须介于 20 和 10000（像素）之间。

响应体说明（Response Data）

Content-Type: application/json

JSON结构说明如下：

字段名	类型	描述
code	integer	错误码，详见“错误码说明”
message	string	错误信息
result	object
+ type	string	证件类型, 当为business_card的时候为名片，当为other的时候,代表无法识别的图片
+ image_angle	integer	指原图需要经过顺时针旋转多少度，才能得到正方向的图片
+ rotated_image_width	integer	正方向时图片的宽
+ rotated_image_height	integer	正方向时图片高
+ item_list	array
++ key	string	识别的字段 family_name 姓 given_name 名 name 姓名 telephone 手机 work_tel 电话 fax 传真 email 邮件 company 公司 department 部门 title 职称 address 地址 url 网址 other 其他信息 QQ QQ crop_image 切图的base64编码,返回JPEG的格式图像
++ value	string	识别的字段的值
++ description	string	识别的字段描述
++ position	array	识别的value在原图中的坐标, 是个长度为8的数组 [0,1,2,3,4,5,6,7] (0, 1) 左上角坐标 (2, 3) 右上角坐标 (4, 5) 左下角坐标 (6, 7) 右下角坐标

JSON结构示例

{
    "code": 200,
    "message": "success",
    "result": {
        "type": "business_card",
        "image_angle": 0,
        "rotated_image_width": 1920,
        "rotated_image_height": 1080,
        "item_list": [
            {
                "key": "name",
                "value": "合小助",
                "description": "姓名",
                "position": [
                    0
                ]
            }
        ]
    }
}

错误码说明

错误码	描述
40101	x-ti-app-id 或 x-ti-secret-code 为空
40102	x-ti-app-id 或 x-ti-secret-code 无效，验证失败
40103	客户端IP不在白名单
40003	余额不足，请充值后再使用
40004	参数错误，请查看技术文档，检查传参
40007	机器人不存在或未发布
40008	机器人未开通，请至市场开通后重试
40301	图片类型不支持
40302	上传文件大小不符，文件大小不超过 10M
40303	文件类型不支持
40304	图片尺寸不符，图像宽高须介于 20 和 10000（像素）之间
40305	识别文件未上传
30203	基础服务故障，请稍后重试
500	服务器内部错误