不动产登记证识别API开发文档

小太阳

不动产登记证识别API开发文档

一、接口简介

1、版权说明：

未经翔云人工智能开放平台授权，不得擅自进行使用。

2、调用客户端运行环境

当客户端使用的编程语言为Java时，请使用1.5及以上版本JRE。

3、服务主要功能描述：翔云不动产登记证识别，可自动、批量识别不动产登记证明中的权利人、共有情况、用途、权利性质、使用期限等文字信息。

1) 通过https协议post方法上传各种图像文件，通过https接口进行识别；

2) 将识别结果以XML或json格式返回给用户；

4、服务调用约束

在调用不动产登记证识别接口前，请您确保客户端程序或设备网络连接通畅，要求图像文件大小在200KB左右，扫描图像建议分辨率为300DPI，图像小于3M。

二、前提准备

1、用户登录 注册账号，如图:

2、输入注册信息，确认无误后点击同意条款并注册，如图:

file:///C:\Users\ADMINI~1\AppData\Local\Temp\ksohtml4976\wps10.jpg

3、注册成功后点击右上角的账号名称-个人中心，进入管理页面:

file:///C:\Users\ADMINI~1\AppData\Local\Temp\ksohtml4976\wps11.jpg

4、点击“用户管理-基础信息”，查看OCRKey以及OCRSecret：

file:///C:\Users\ADMINI~1\AppData\Local\Temp\ksohtml4976\wps12.jpg

5、点击“服务列表”，查看服务次数及余额(每调用一次https接口消耗一次)，可点击立即购买直接跳转到购买页面购买API服务次数：

file:///C:\Users\ADMINI~1\AppData\Local\Temp\ksohtml4976\wps13.jpg

6、购买成功后,会显示购买的总次数及剩余次数，例如下图所示：

file:///C:\Users\ADMINI~1\AppData\Local\Temp\ksohtml4976\wps14.jpg

7、设置剩余条数提醒，进入个人中心-用户管理-剩余条数提醒，设置提醒下线、通知手机号及服务类型，设置成功后到达用户设置的服务剩余条数下限，系统会发短息至预留手机号。

file:///C:\Users\ADMINI~1\AppData\Local\Temp\ksohtml4976\wps15.jpg

三、接口说明

接口地址，图片为base64流：

图片为file格式：

（注：调用图片为base64流接口时传参数img，调用图片为file格式接口传参数file）

接口调用方法：post

3、请求参数

名称	类型	必填	说明
file	MultipartFile	是	上传的文件(上传文件的字段名必须是“file”)
img	String	是	上传的文件(图片的base64流)
key	String	是	用户ocrKey
secret	String	是	用户ocrSecrert
typeId	Integer	是	识别类型：41
format	String	是	返回格式(xml或者json)，如果format为空，则默认返回xml

识别结果字符串
<status/>标签显示了识别状态，大于等于“0”代表识别成功【“0”代表查询成功，“1”代表未查到数据，“2”代表查询失败】，小于“0”代表识别失败，失败的原因在<value/>中描述。

调用错误码

status值	描述
-1	用户已屏蔽
-2	用户key或secret验证错误
-3	服务次数不足
-4	用户未找到
-6	系统异常
-7	图片不可为空，参数不可为空
-8	类型错误

识别错误码1

status值	描述
-1	识别失败

调用方式(java客户端基于httpclient4.3)
1.依赖库: \java客户端\httpClient4.3库\，如图:

file:///C:\Users\ADMINI~1\AppData\Local\Temp\ksohtml4976\wps16.png

2.示例程序代码详见: \java客户端\httpClientDemo\中的Client类，如图:

file:///C:\Users\ADMINI~1\AppData\Local\Temp\ksohtml4976\wps17.png

在main方法定义参数，并传入   doPost(url, file, key, secret, typeId, format) 方法中。如图:

file:///C:\Users\ADMINI~1\AppData\Local\Temp\ksohtml4976\wps18.jpg

识别结果如下：

{

    "message": {

        "status": 2,

        "value": "识别完成"

    },

    "cardsinfo": [

        {

            "type": "41",

            "items": [

                {

                    "nID": null,

                    "index": null,

                    "desc": "权利人",

                    "content": ""

                },

                {

                    "nID": null,

                    "index": null,

                    "desc": "共有情况",

                    "content": ""

                },

                {

                    "nID": null,

                    "index": null,

                    "desc": "坐落",

                    "content": ""

                },

                {

                    "nID": null,

                    "index": null,

                    "desc": "不动产单元号",

                    "content": ""

                },

                {

                    "nID": null,

                    "index": null,

                    "desc": "权利类型",

                    "content": ""

                },

                {

                    "nID": null,

                    "index": null,

                    "desc": "权利性质",

                    "content": ""

                },

                {

                    "nID": null,

                    "index": null,

                    "desc": "用途",

                    "content": ""

                },

                {

                    "nID": null,

                    "index": null,

                    "desc": "面积",

                    "content": ""

                },

                {

                    "nID": null,

                    "index": null,

                    "desc": "使用期限",

                    "content": ""

                },

                {

                    "nID": null,

                    "index": null,

                    "desc": "权利其他状况",

                    "content": ""

                },

                {

                    "nID": null,

                    "index": null,

                    "desc": "不动产权第号",

                    "content": ""

                }

        }

}

剩余条数查询接口(所有产品类型)

接口地址：
接口调用方法：	post
接口接收参数：
String key：	用户ocrKey
String secret：	用户ocrSecret
String format：	返回格式(xml或者json)，如果format为空，则默认返回xml