1. 接口列表

本节包含AI智能-文字识别相关接口等

以下接口,返回数据中 msg、 data 不是一定会返回的,但requestId 和 code 是必定会返回

注:ocr接口中image为需识别图片内容,该图片中文字尽量为横向,否则会无法识别

接口列表如下:

序号 接口功能 描述
1 通用文字识别 通用文字识别
2 银行卡识别 银行卡识别
3 身份证识别 识别身份证
4 驾驶证识别 驾驶证识别
5 行驶证识别 行驶证识别
6 营业执照识别 营业执照识别
7 通用票据识别 通用票据识别
  • 公共返回码:
code msg 备注
200 操作成功
10001 参数错误
10002 accessToken过期或异常
10004 用户不存在
10005 appKey异常
10007 调用次数超限
10013 无权限调用
10029 接口调用太频繁
49999 操作异常 接口调用异常
50000 服务器异常
60200 非法的服务名
60201 确实必传参数或参数校验错误
60202 参数解析错误
60203 未开通相关服务
60204 服务已开通
60205 服务内部错误
60206 并发数超限
60210 图片数据错误
60211 图片尺寸错误(太大或太小)
60212 图片大小超过2M限制
60213 下载图片失败
60405 图片地址错误
60507 服务超时
60508 服务器繁忙
60509 该功能暂时不支持
60511 OCR识别失败

1.1. 通用文字识别

  • 接口功能

    该接口用于对一张图片的文字识别能力,分析带文字图片的相关数据

  • 请求地址

    https://open.ys7.com/api/lapp/intelligence/ocr/generic

  • 请求方式

    POST

  • 子账户token请求所需最小权限

  • 请求参数
参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
dataType int 数据类型(0:图片URL; 1:base64 编码的二进制图片数据) Y
image String 待分析的图片数据或URL,图片数据大小最大2M. 注:
下载图片时可能由于网络等原因导致下载图片时间过长,建议使用base64 参数直接上传图片;
不支持对获得的图片数据进行加解密操作
Y
operation String 默认仅返回文字,rect:返回文字坐标 N

图片大小 800 * 600 px -- 4096 * 2160 px (但宽不能大于4096 px 且高不能大于2160 px)

  • HTTP请求报文
POST /api/lapp/intelligence/ocr/generic  HTTP/ 1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&dataType=1&image=asdfasdfasdfasdfadf&operation=rect
  • 返回数据
{
    "requestId": "ba37e869a03946288edc36d413I013c2",
    "data": {
        "words": [
            "静夜思",
            "李白",
            "床前明月光,疑是地上霜",
            "举头望明月,低头思故乡。"
        ],
        "locations": [
            {
                "x": 410,
                "y": 507,
                "width": 425,
                "height": 141
            },
            {
                "x": 557,
                "y": 689,
                "width": 155,
                "height": 79
            },
            {
                "x": 235,
                "y": 898,
                "width": 763,
                "height": 87
            },
            {
                "x": 240,
                "y": 1045,
                "width": 786,
                "height": 93
            }
        ]
    },
    "code": "200",
    "msg": "操作成功"
}
  • 返回字段
字段名 类型 描述
words Map 每行的文字
locations Array 检测出的人形列表,如果没有检测出人形则为空数组
  • location
Location Map 坐标
height int 文字的高度,单位px
width int 文字的宽度,单位px
x int 文字左上角的横坐标,单位px
y int 文字左上角的纵坐标,单位px
  • 返回码

参见 公共返回码

1.2. 银行卡识别

  • 接口功能

    该接口用于提供对一张银行卡的识别能力,分析银行卡的相关数据

  • 请求地址

    https://open.ys7.com/api/lapp/intelligence/ocr/bankCard

  • 请求方式

    POST

  • 子账户token请求所需最小权限

  • 请求参数
参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
dataType int 数据类型(0:图片URL; 1:base64编码的二进制图片数据) Y
image String 待分析的图片数据或URL,图片数据大小最大2M. 注:
下载图片时可能由于网络等原因导致下载图片时间过长,建议使用base64参数直接上传图片;
不支持对获得的图片数据进行加解密操作
Y

图片大小 800 * 600 px -- 4096 * 2160 px (但宽不能大于4096 px 且高不能大于2160 px)

  • HTTP请求报文
POST /api/lapp/intelligence/ocr/bankCard  HTTP/ 1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&dataType=1&image=asdfasdfasdfasdfadf
  • 返回数据
{
    "requestId": "ba37e869a03946288edc36d413I013e1",
    "data": {
        "name": "工商银行",
        "number": "9558 8220 1000 5085629",
        "type": 1
      },
    "code": "200",
    "msg": "操作成功"
}
  • 返回字段
字段名 类型 描述
name String 每行的文字
number String 银行卡号
type int 银行卡类型,0: 不能识别; 1: 借记卡; 2: 信用卡
  • 返回码

参见 公共返回码

1.3. 身份证识别

  • 接口功能

    该接口用于提供对一张身份证的识别能力,分析身份证的相关数据

  • 请求地址

    https://open.ys7.com/api/lapp/intelligence/ocr/idCard

  • 请求方式

    POST

  • 子账户token请求所需最小权限

  • 请求参数
参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
dataType int 数据类型(0:图片URL; 1:base64 编码的二进制图片数据) Y
image String 待分析的图片数据或URL,图片数据大小最大2M. 注:
下载图片时可能由于网络等原因导致下载图片时间过长,建议使用base64参数直接上传图片;
不支持对获得的图片数据进行加解密操作
Y
front boolean 是否身份证正面带照片的一面,true - 正面, false - 反面 Y
operation String 默认仅返回文字,rect-返回文字坐标 Y

图片大小 800 * 600 px -- 4096 * 2160 px (但宽不能大于4096 px 且高不能大于2160 px)

  • HTTP请求报文
POST /api/lapp/intelligence/ocr/idCard  HTTP/ 1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&dataType=1&image=asdfasdfasdfasdfadf&front=true
  • 返回数据
{   
    "requestId": "ba37e869a03946288edc36d413I013d3",
    "data": {
        "words": {
            "姓名": "刘伟",
            "民族": "彝",
            "住址": "云南省临沧市凤庆县新华彝族乡刘家小组23号",
            "公民身份号码": "533522199107060816",
            "出生": "19910706",
            "性别": "男"
        },
        "locations": {
            "姓名": {
                "x": 324,
                "y": 284,
                "width": 100,
                "height": 42
            },
            "民族": {
                "x": 541,
                "y": 366,
                "width": 29,
                "height": 36
            },
            "住址": {
                "x": 325,
                "y": 519,
                "width": 417,
                "height": 103
            },
            "公民身份号码": {
                "x": 490,
                "y": 717,
                "width": 550,
                "height": 59
            },
            "出生": {
                "x": 319,
                "y": 435,
                "width": 351,
                "height": 48
            },
            "性别": {
                "x": 326,
                "y": 371,
                "width": 29,
                "height": 37
            }
        }
    },
    "code": "200",
    "msg": "操作成功"
}
  • 返回字段
字段名 类型 描述
locations Map 每个字段对应的坐标信息(注:如果没有检测出文字则为空)
words Map 每个字段信息
  • location
Location Map 坐标
height int 文字的高度,单位px
width int 文字的宽度,单位px
x int 文字左上角的横坐标,单位px
y int 文字左上角的纵坐标,单位px
  • 返回码

参见 公共返回码

1.4. 驾驶证识别

  • 接口功能

    该接口用于提供对一张驾驶证的识别能力,分析驾驶证的相关数据

  • 请求地址

    https://open.ys7.com/api/lapp/intelligence/ocr/driverLicense

  • 请求方式

    POST

  • 子账户token请求所需最小权限

  • 请求参数
参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
dataType int 数据类型(0:图片URL; 1:base64 编码的二进制图片数据) Y
image String 待分析的图片数据或URL,图片数据大小最大2M. 注:
下载图片时可能由于网络等原因导致下载图片时间过长,建议使用base64 参数直接上传图片;
不支持对获得的图片数据进行加解密操作
Y

图片大小 800 * 600 px -- 4096 * 2160 px (但宽不能大于4096 px 且高不能大于2160 px)

  • HTTP请求报文
POST /api/lapp/intelligence/ocr/driverLicense HTTP/ 1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&dataType=1&image=asdfasdfasdfasdfadf
  • 返回数据
{
    "requestId": "ba37e869a03946288edc36d413I013H1",
    "data": {
        "words": {
            "车辆识别代号": "LSGJT52U67H106722",
            "住址": "广东省佛山市禅城区张提街朗沪路71号",
            "品牌型号": "别克牌SGN7161LEAT",
            "发证日期": "20140827",
            "车辆类型": "小型轿车",
            "所有人": "李厚堂",
            "使用性质": "非营运",
            "发动机号码": "76110577",
            "号牌号码": "粤E15K05",
            "注册日期": "20120906"
        }
    },
    "code": 200,
    "msg": "操作成功"
}
  • 返回字段
字段名 类型 描述
words Map 每个字段信息
  • 返回码

参见 公共返回码

1.5. 行驶证识别

  • 接口功能

    该接口用于提供对一张行驶证的识别能力,分析行驶证的相关数据

  • 请求地址

    https://open.ys7.com/api/lapp/intelligence/ocr/vehicleLicense

  • 请求方式

    POST

  • 子账户token请求所需最小权限

  • 请求参数
参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
dataType int 数据类型(0:图片URL; 1:base64编码的二进制图片数据) Y
image String 待分析的图片数据或URL,图片数据大小最大2M. 注:
下载图片时可能由于网络等原因导致下载图片时间过长,建议使用base64 参数直接上传图片;
不支持对获得的图片数据进行加解密操作
Y

图片大小 800 * 600 px -- 4096 * 2160 px (但宽不能大于4096 px 且高不能大于2160 px)

  • HTTP请求报文
POST /api/lapp/intelligence/ocr/vehicleLicense  HTTP/ 1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&dataType=1&image=asdfasdfasdfasdfadf
  • 返回数据
{
    "requestId": "ba37e869a03946288edc36d413I013H1",
    "data": {
        "words": {
            "车辆识别代号": "LSGJT52U67H106722",
            "住址": "广东省佛山市禅城区张提街朗沪路71号",
            "品牌型号": "别克牌SGN7161LEAT",
            "发证日期": "20140827",
            "车辆类型": "小型轿车",
            "所有人": "李厚堂",
            "使用性质": "非营运",
            "发动机号码": "76110577",
            "号牌号码": "粤E15K05",
            "注册日期": "20120906"
        }
    },
    "code": 200,
    "msg": "操作成功"
}
  • 返回字段
字段名 类型 描述
words Map 每个字段信息
  • 返回码

参见 公共返回码

1.6. 营业执照识别

  • 接口功能

    该接口用于提供对一张营业执照的识别能力,分析营业执照的相关数据

  • 请求地址

    https://open.ys7.com/api/lapp/intelligence/ocr/businessLicense

  • 请求方式

    POST

  • 子账户token请求所需最小权限

  • 请求参数
参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
dataType int 数据类型(0:图片URL; 1:base64编码的二进制图片数据) Y
image String 待分析的图片数据或URL,图片数据大小最大2M. 注:
下载图片时可能由于网络等原因导致下载图片时间过长,建议使用base64 参数直接上传图片;
不支持对获得的图片数据进行加解密操作
Y
operation String 默认仅返回文字,rect:返回文字坐标 Y

图片大小 800 * 600 px -- 4096 * 2160 px (但宽不能大于4096 px 且高不能大于2160 px)

  • HTTP请求报文
POST /api/lapp/intelligence/ocr/businessLicense  HTTP/ 1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&dataType=1&image=asdfasdfasdfasdfadf
  • 返回数据
{   
    "requestId": "ba37e869a03946288edc36d413I013d3",
    "data": {
        "words": {
            "姓名": "刘伟",
            "民族": "彝",
            "住址": "云南省临沧市凤庆县新华彝族乡刘家小组23号",
            "公民身份号码": "533522199107060816",
            "出生": "19910706",
            "性别": "男"
        },
        "locations": {
            "姓名": {
                "x": 324,
                "y": 284,
                "width": 100,
                "height": 42
            },
            "民族": {
                "x": 541,
                "y": 366,
                "width": 29,
                "height": 36
            },
            "住址": {
                "x": 325,
                "y": 519,
                "width": 417,
                "height": 103
            },
            "公民身份号码": {
                "x": 490,
                "y": 717,
                "width": 550,
                "height": 59
            },
            "出生": {
                "x": 319,
                "y": 435,
                "width": 351,
                "height": 48
            },
            "性别": {
                "x": 326,
                "y": 371,
                "width": 29,
                "height": 37
            }
        }
    },
    "code": "200",
    "msg": "操作成功"
}
  • 返回字段
字段名 类型 描述 是否必须
locations Map 每个字段对应的坐标信息(注:如果没有检测出文字则为空) N
words Map 每个字段信息 N
  • location
Location Map 坐标
height int 文字的高度,单位px
width int 文字的宽度,单位px
x int 文字左上角的横坐标,单位px
y int 文字左上角的纵坐标,单位px
  • 返回码

参见 公共返回码

1.7. 通用票据识别

  • 接口功能

    该接口用于提供对一张票据的识别能力,分析票据的相关数据

  • 请求地址

    https://open.ys7.com/api/lapp/intelligence/ocr/receipt

  • 请求方式

    POST

  • 子账户token请求所需最小权限

  • 请求参数
参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
dataType int 数据类型(0:图片URL;1:base64 编码的二进制图片数据) Y
image String 待分析的图片数据或URL,图片数据大小最大2M. 注:
下载图片时可能由于网络等原因导致下载图片时间过长,建议使用base64 参数直接上传图;
不支持对获得的图片数据进行加解密操作
Y
operation String 默认仅返回文字,rect:返回文字坐标 Y

图片大小 800 * 600 px -- 4096 * 2160 px (但宽不能大于4096 px 且高不能大于2160 px)

  • HTTP请求报文
POST https://open.ys7.com/api/lapp/intelligence/ocr/receipt  HTTP/ 1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&dataType=1&image=asdfasdfasdfasdfadf
  • 返回数据
{
    "requestId": "36cdc191e89a42c9938771177e757f9d",
    "data": {
        "words": [
            "广东省行政事业型收费统一票据",
            "AdmnistatonandlerpiseschargeUntaryi",
            "ofGuangdongProvnce",
            "广东省",
            "AC4965752",
            "缴款单位(人):",
            "2013年9月18日",
            "Payer",
            "改",
            "M",
            "D",
            "执收单位代码项目编码",
            "项目名称|计费单位计费数量收费标准金额",
            "Unitword",
            "ltemcode",
            "Chargetem",
            "Unit",
            "Quantity|ChageSandad",
            "Amount",
            "30086001301|往来港澳通行证",
            "40.00",
            "第",
            "联",
            "存8",
            "合计十人民币(大写)佰拾万\\4四贔零元零角¥¥40.0",
            "①",
            "金",
            "缴款通知书编号",
            "缴款方",
            "(03)",
            "根",
            "AdvceNoteNo",
            "PaymentMethod",
            "现金",
            "备注",
            "Notes",
            "收款单位(盖章):",
            "开票人:周婉玲",
            "收款人:",
            "广东省财政厅印制",
            "Receiver(seal)",
            "Drawe",
            "Payee",
            "printedbyGuangdongPr",
            "Bureau",
            "(机打票据,手写无效)"
        ]
    },
    "code": "200",
    "msg": "操作成功"
  }
  • 返回字段
字段名 类型 描述
words Array 每个字段信息
  • 返回码

参见 公共返回码

results matching ""

    No results matching ""