/ocr/qrcode_parser
1.接口描述
该 API 用于对二维码进行解析
- 图片要求：
- 格式为 JPG(JPEG), PNG
- 宽和高大于 128px, 小于等于 6000px
- 小于等于 5 MB
请求方式
POST
请求 URL
https://cloudapi.deepfinch.com/ocr/qrcode_parser
调试工具
2.请求参数
2.1 请求头域
| 字段 | 类型 | 必需 | 描述 |
|---|---|---|---|
| X-DF-API-ID | string | 是 | API调用凭证信息，详细信息请参考API调用 |
| X-DF-API-SECRET | string | 是 | API调用凭证信息，详细信息请参考API调用 |
2.2 请求体
| 字段 | 类型 | 必需 | 描述 |
|---|---|---|---|
| file | file | 见下方注释 | 需上传的图片文件，上传本地图片进行检测时选取此参数 |
| url | string | 见下方注释 | 图片网络地址，采用抓取网络图片方式时需选取此参数 |
请求参数
file与url二选一。
url 中若含有特殊字符，则需要对这些字符进行转义，所有中文和特殊字符必需以UTF-8编码转义。
目前支持 http/https 协议的网络地址。下载限时 5s，超时后仍未下载完成则属于失败。
参数file需把图片文件以 multipart/form-data 的形式放到 POST 消息体中。
3.返回参数
| 字段 | 类型 | 说明 |
|---|---|---|
| request_id | string | 本次请求的id |
| image_id | string | 本次请求的图片id |
| status | string | 状态，正常为 OK |
| result | string | 二维码解析结果 |
返回结果示例
{
"request_id": "TID36fcfa2a0f2041cb95f9baace01212b6",
"status": "OK",
"image_id": "8f839fbb1f614047a996ac243421d110",
"result": "CZ-EI-31,1.1.0,356765121,1052432406110,406210,20210124,2851.41000"
}
4.错误码
| 状态码 | status 字段 |
说明 |
|---|---|---|
400 |
INVALID_ARGUMENT | 请求参数错误 |
400 |
DETETION_FAILED | 图片检测失败 |
400 |
DOWNLOAD_ERROR | 网络地址图片获取失败 |
401 |
UNAUTHORIZED | 未授权或授权失败 |
401 |
KEY_EXPIRED | 账号过期 |
403 |
NO_PERMISSION | 无调用权限 |
403 |
OUT_OF_QUOTA | 调用次数超出限额 |
403 |
RATE_LIMIT_EXCEEDED | 调用频率超出限额 |
404 |
NOT_FOUND | 请求路径错误 |
500 |
INTERNAL_ERROR | 服务器内部错误 |
备注: 以上40X系列错误描述请参考reason字段
输出样例
{
"status": "INVALID_ARGUMENT",
"reason": "must specify 'file' or 'url' argument",
"request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}