You need to enable JavaScript to run this app.
导航
调用方式
最近更新时间:2023.08.18 18:00:51首次发布时间:2022.07.21 17:01:19
接口简介

支持对食品经营许可证照所有关键字段的识别。

限制条件
名称内容
输入要求1. 文件格式:支持JPG、JPEG、PNG、BMP、PDF等常见格式,建议使用JPG格式。
2. 文件大小:
a.要求Base64编码和urlencode之后不超过 8 MB。
b.如果传图片及PDF完整URL,URL对应文件大小建议不要超过8MB。
3. 输入文件过大时,返回的HttpCode如下:400/413/502。
4. 输入多页PDF时,默认只识别第一页。
请求说明

基本信息

名称内容
接口地址https://visual.volcengineapi.com
请求方式POST
Content-Typeapplication/x-www-form-urlencoded
是否需要鉴权

请求参数

header请求参数

以下请求参数列表仅列出了接口请求参数和必要公共参数,完整公共参数列表见 公共参数

名称类型是否必填描述
X-DateString使用UTC时间,精确到秒。请使用格式:YYYYMMDD'T'HHMMSS'Z' ,例如:20201103T104027Z

Authorization

String

HMAC-SHA256:签名方法
-Credential为签名凭证,其中:
-AccessKeyId为访问密钥ID,可在 访问密钥(Access Key) 获取;
-ShortDate为请求的短时间,使用UTC时间,精确到日。请使用格式:YYYYMMDD,例如:20180201
-Region为请求地区,国内一般为为cn-north-1
-Service为请求的服务,文字识别一般为cv
-SignedHeaders为参与签名计算的头部信息,content-typehost 为必选头部;
-Signature为签名,可在 签名方法 获取。
注:我们提供了SDK及签名示例供您实现服务快速接入,具体可参考 快速接入
例如:HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}

X-Security-TokenString指安全令牌服务(Security Token Service,STS) 颁发的临时安全凭证中的SessionToken,使用长期密钥时无需填写该参数。

Query请求参数

参数可选/必选类型说明
Action必选String接口名,取值:OcrFoodBusiness
Version必选String版本号,取值:2020-08-26

Body参数

参数可选/必选类型说明
image_base64与image_url二选一String图片文件,base64编码
注意: 只需要传图片的base64值,类似data:image/png;base64的图片头不要传入
image_url与image_base64二选一String图片/PDF文件的URL链接
注意: 要求image_base64与image_url二选一,如果2个字段都有,优先解析image_base64。
输出说明

通用输出参数

请参考通用返回字段及错误码 |

业务输出参数

data 字段说明

字段类型说明备注
license_mainmain_info主页面信息

main_info 字段说明

字段类型说明备注
有效期至string有效期至
签发人string签发人
发证机关string发证机关
投诉举报电话string投诉举报电话
许可证编号string许可证编号
住所string住所
法定代表人(负责人)string法定代表人(负责人)
社会信用代码(身份证号)string社会信用代码(身份证号)
经营者名称string经营者名称
经营场所string经营场所
日常监督管理机构string日常监督管理机构
日常监督管理人员string日常监督管理人员
主体业态string主体业态
经营项目string经营项目

输出示例

{
    "code":10000,
    "data":{
        "license_main":
            {
                "主体业态":"食品销售经营者食杂店",
                "住所":"盛泽镇市场路北侧(舜湖西路南侧)",
                "发证机关":"滨江市吴江区市场监督管理局",
                "投诉举报电话":"12331",
                "日常监督管理人员":"崔晓翔,陈剑",
                "日常监督管理机构":"滨江市海河区市场监督管理局四分",
                "有效期至":"2024年6月26日",
                "法定代表人(负责人)":"朱丽",
                "社会信用代码":"11112345MA1PF3Q23T",
                "签发人":"邱鸿",
                "经营场所":"盛泽镇市场路北侧(舜湖西路南侧)",
                "经营者名称":"海河市盛泽镇茶缘阁茶叶店",
                "经营项目":"预包装食品(不含冷藏冷冻食品)销售",
                "许可证编号":"JY13205840161234",
                "证书类型":"食品经营许可证"}
            },
        "message":"Success",
        "request_id":"69740059170124616041623762222",
        "status":10000,
        "time_elapsed":"1.864290066s"
}

错误码

通用错误码

请参考通用返回字段及错误码

业务错误码

HttpCode错误码错误消息描述
20010000请求成功
40050205"Image Size Exceeds Maximum Limit: please compress the image"输入文件过大
40050206"Invalid Input Image: image is empty"输入图片为空
40050207"Image Decode Error: image format unsupported"图片解码错误
40050217"Process PDF File Error."处理PDF文件错误
40060103"Missing Input Parameters: empty input image"输入图片为空
40060301"Invalid Input Image: get input image error"获取图片错误
40061301"Invalid Input Parameters: Input image can not be decoded"输入图片错误