天翼云事业单位法人证书识别API文档
文档简介：
1、接口描述。
针对事业单位法人证书图片，进行OCR检测，返回检测到的统一社会信用代码、名称、住所、法定代表人、开办资金、举办单位、有效期、经费来源等信息。
咨询热线：400-826-7010，为您提供专业的售前咨询，让您快速了解云产品，助您轻松上云！
微信咨询
免费试用、价格特惠
1、接口描述
针对事业单位法人证书图片，进行OCR检测，返回检测到的统一社会信用代码、名称、住所、法定代表人、开办资金、举办单位、有效期、经费来源等信息。
2、请求方法
POST
3、接口要求
- 图片格式限制：目前仅支持 png、jpg、jpeg、bmp格式。
- 图片大小限制：单张图片大小不超过 7 MB。
- 图片尺寸限制：图片像素尺寸应不小于 32x32，不大于 5000x5000。
4、请求URL
/v1/aiop/api/2k8jrue2nk84/shiyefaren/ocr/v1/Shiyefaren.json复制
5、请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Content-Type | 是 | string | json 格式 | "application/json" | |
| appkey | 是 | string | 诸葛 AI 应用 appkey | "562b89493b1a40e1b97ea05e50dd8170" |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Action | 是 | string | 请求参数放置于http body中，action代表需要请求的具体算法，只能为"SyfrLicenseOCR" | "SyfrLicenseOCR" | |
| ImageData | 是 | string | 一张图像Base64编码数据string。图片需要使用常规safe base64编码方式 |
6、请求代码示例
Curl -X POST "https://ai-global.ctapi.ctyun.cn/v1/aiop/api/2k8jrue2nk84/shiyefaren/ocr/v1/Shiyefaren.json"
-H "Content-Type: application/json"
-H "ctyun-eop-request-id:33dfa732-b27b-464f-b15a-21ed6845afd5"
-H "appkey:XXX"
-H "Eop-Authorization:XXX"
-H "eop-date:20211109T104641Z"
-H "host:ai-global.ctapi.ctyun.cn"
--data '{"Action": "SyfrLicenseOCR","ImageData": "9j_4AAQSkZJRgABAQAAAQABAAD_4QAwRXhpZgAATU0AKgAAA..."}'复制
7、返回值说明
请求成功返回响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| code | 是 | int | 返回状态，返回0表示成功，返回错误代码参考下面的错误代码列表 | 0 | |
| message | 是 | string | 如果code为0，返回success；如果code非0，则返回对应的可读错误信息 | "success" | |
| result | 是 | object | 识别的结果字典，字典内包事业单位法人证书的整体判断信息以及统一社会信用代码、名称、住所等详细键值对信息 | result |
表result
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| license_type | 是 | string | 事业单位法人证书的整体判断信息，'Shiyefaren License'表示图片是事业单位法人证书，'Not Shiyefaren License'表示图片不是事业单位法人证书 | - | |
| detail | 是 | object | 返回结果键值集合，包含统一社会信用代码、名称、住所等信息 | - | detail |
表detail
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| union_id | 是 | string | 统一社会信用代码 | - | |
| name | 是 | string | 名称 | - | |
| addr | 是 | string | 住所 | - | |
| legal_rep | 是 | string | 法定代表人 | - | |
| regist_captial | 是 | string | 开办资金 | - | |
| organization | 是 | string | 举办单位 | - | |
| operation_period | 是 | string | 有效期 | - | |
| money_source | 是 | string | 经费来源 |
请求失败返回响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| code | 是 | int | 错误码，参见本文档错误码说明部分 | 400009 | |
| message | 是 | string | 返回对应的错误信息 | "Action值设置错误" | |
| details | 是 | string | 返回对应的错误描述 | "Action值设置错误" |
8、返回值示例
请求成功返回值示例
{
"code": 0,
"message": "success",
"result": {
"license_type": "Shiyefaren License",
"detail": {
"union_id": "12350XXXXXXXX6547U",
"name": "福建中国XXXXXX",
"addr": "泉州市XXXXXX北侧",
"legal_rep": "林XX",
"regist_captial": "￥60万元",
"organization": "中国XXXXXX委员会",
"operation_period": "自2016年04月05日至2021年04月05日",
"money_source": "财政拨款"
}
}
}复制
请求失败返回值示例
{
"code": 400009,
"message": "Action值设置错误",
"details": "Action值设置错误"
}复制
9、状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
10、错误码说明
6 位错误码。4 开头为业务错误码，5 开头为服务错误码。
| 错误码 | 错误信息 | 错误描述 |
|---|---|---|
| 400003 | body内容为空 | Body请求数据为空，没有包含内容 |
| 400004 | body请求体非json格式 | body内容需要符合json要求 |
| 400005 | 请求体类型错误 | 请求体需为字典，不能为其他类型 |
| 400006 | 必传的参数未传 | 必须的参数（'Action'、'ImageData'）未传 |
| 400007 | 传递非法参数 | body字典内有除（'Action'、'ImageData'）外的参数 |
| 400008 | 请求体的字段类型错误 | 请求体的字段（'Action'、'ImageData'）类型错误，类型只能为字符串，不能为其他类型 |
| 400009 | Action值设置错误 | Action值设置错误 |
| 400010 | 'ImageData'字段值为空字符 | 'ImageData'字段值为空字符 |
| 400011 | 'ImageData'字段base64数据处理异常 | 'ImageData'字段的base64字符串转换字节码异常 |
| 400012 | 请求文件格式不合法 | 仅支持 jpeg/png/jpg/bmp 格式 |
| 400013 | 图片文件大小不符合要求 | 该文件大小不符合要求，静态图片要求小于7M |
| 400014 | 图片解码错误 | 字节码解码为图片错误 |
| 400015 | 图片尺寸不符合要求 | 分辨率长宽尺寸应不高于5000不低于32 |
| 500001 | 服务接口异常，请联系管理员 | 需要联系管理员处理 |
11、base64 编码规则：使用常规的 safe base64 编码方式
- python 中推荐使用 base64.urlsafe_b64encode() 函数进行编码。
- java 中推荐使用 BASE64.getUrlEncoder().encodeToString() 函数进行编码。
