接口文档
最近更新时间：2021.12.16 13:59:15
首次发布时间：2021.12.16 13:59:15
接入指引
请先查看接入指引了解具体接入方式，再参考此文档完成接入。
请求API
| 名称 | 内容 |
|---|---|
| 请求方式 | POST |
| Content-Type | application/x-www-form-urlencoded |
| 图片要求 | 1. 图片格式：JPG、JPEG、PNG、BMP等常见格式，建议使用JPG格式。 2. 图片文件大小：最大 5 MB。 |
输入参数
Query参数：
| 参数 | 可选/必选 | 类型 | 说明 |
|---|---|---|---|
| Action | 必选 | String | 接口名，取值：OcrTaibao |
| Version | 必选 | String | 版本号，取值：2021-08-23 |
Body参数：
| 参数 | 可选/必选 | 类型 | 说明 |
|---|---|---|---|
| image_base64 | 必选 | String | 图片base64编码 |
API返回 （通用返回字段见通用返回字段及错误码）
data 字段说明
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| license_main | main_info | 主页面信息 | 字段说明见下方 |
main_info 字段说明
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| title | String | 证件名称 | 主页信息 |
| chn_name | String | 中文名 | 主页信息 |
| eng_name | String | 英文名 | 主页信息 |
| birth_date | String | 出生日期 | 主页信息 |
| sex | String | 性别 | 主页信息 |
| valid_date | String | 有效期限 | 主页信息 |
| register_office | String | 签发机关 | 主页信息 |
| register_address | String | 签发地点 | 主页信息 |
| num | String | 证件号码 | 主页信息 |
| register_count | String | 签发次数 | 主页信息 |
错误码（通用错误码见通用返回字段及错误码）
| HttpCode | 错误码 | 错误消息 | 描述 |
|---|---|---|---|
| 200 | 10000 | 无 | 请求成功 |
| 400 | 60103 | "Missing Input Parameters: empty input image" | 输入图片为空 |
| 400 | 60301 | "Invalid Input Image: get input image error" | 获取图片错误 |
| 400 | 61301 | "Invalid Input Parameters: Input image can not be decoded" | 输入图片错误 |
返回值示例
主页面图片返回值示例
{ "code":10000, "data":{ "license_main":{ "title":"台湾居民来往大陆通行证", "chn_name":"证件样才", "eng_name":"ZHENG-JIAN,", "birth_date":"1981.08.03", "sex":"女", "valid_date":"2015.06.09-2020.06.08", "register_office":"公安部出入境管理局", "register_address":"福建", "num":"00000000", "register_count":"01" } }, "message":"Success", "request_id":"69060562706382213251607941527", "status":10000, "time_elapsed":"481.956877ms" }