EASTCOMS东信智能 - 中国领先的身份证社保卡智能终端应用服务商

eastcoms@qq.com
400-6722-705
首页 > 服务支持专区 > 产品支持 > 产品文档下载

东信智能手持式人证合一验证设备平台接口协议v0.0.1

来源:www.eastcoms.com   标签:接口协议 东信 手持式 人证合一   发布时间: 2018-12-27 10:56:04

本协议主要是为了第三方系统与东信手持式身份证验证平台通过Http Post方式进行数据交互,文档是面向具备一定的http开发经验的开发者。

《东信智能手持式人证合一验证设备平台接口协议v0.0.1》

目    录

1. 简介 1

1.1. Https方式接入 1

1.2. 面向的读者 1

1.3. 返回数据 1

2. 协议定义 1

2.1. 上传人证比对记录 1

2.1.1. 描述 1

2.1.2. 接口定义 1

2.1.3. 输入参数 1

2.1.4. 输出参数 2

2.2. 发送设备心跳 2

2.2.1. 描述 2

2.2.2. 接口定义 2

2.2.3. 输入参数 2

2.2.4. 输出参数 2

2.3. 设备注册 3

2.3.1. 描述 3

2.3.2. 接口定义 3

2.3.3. 输入参数 3

2.3.4. 输出参数 3

2.4. 获取验证策略 3

2.4.1. 描述 3

2.4.2. 接口定义 3

2.4.3. 输入参数 3

2.4.4. 输出参数 4

2.5. 获取版本 4

2.5.1. 描述 4

2.5.2. 接口定义 4

2.5.3. 输入参数 4

2.5.4. 输出参数 4

1.简介

1.1.Https方式接入

第三方系统与人证合一平台通过Http Post方式进行数据交互。

本协议涉及到的中文均采用UTF-8编码格式,为了显示美观数据样本手工加入折行。

1.2.面向的读者

《人证合一平台接口协议》文档是面向具备一定的http开发经验的开发者。

1.3.返回数据

该平台提供的接口返回数据为json。

2.协议定义

2.1.上传人证比对记录

2.1.1.描述

人证合一客户端将比对记录上传到平台,平台保存比对记录用于后续操作。

2.1.2.接口定义

https://ip:port/fvms/api/uploadCmpRecord

2.1.3.输入参数

参数名称 类型 必填 参数说明 备注

deviceNo String(1,64) Y 设备号

name String(1,32) Y 姓名

cardno String(1,18) Y 证件号

cardImg String Y 身份证照base64数据

spotImg String Y 现场照base64数据

score smallint (3) Y 对比分数

threshold smallint (3) Y 阈值

validateType

smallint (1) Y 验证模式(1:只验人脸 2:人脸或指纹任意通过 3:人脸、指纹同时通过)

faceResult smallint (1) Y 人脸比对结果(1:成功 2:失败 3:未检测到人脸)

fingerResult smallint (1) Y 指纹比对结果(1:成功 2:失败 3:未检测到指纹 4.指纹不检 只验证人脸 4

fingerNum String(3) Y 指纹现场比对次数(-,0/1 1/1) 只验证人脸  -

result smallint (1) Y 最终结果(1:成功 2:失败 3:未检测到人脸 4:未检测到指纹 )

folk String(30) Y 民族

sex smallint (1) Y 性别(1:男 2:女 3:未知)

birthday String(10) Y 生日

address String(1,255) Y 家庭地址

validdate1 String(1,16) Y 身份证开始有效期

validdate2 String(1,16) Y 身份证结束有效期

authority String(1,128) Y 签发机关

compareDate long Y 比对时间

请求样例:

requestData="{"address":"重庆市渝中区龙华大道","authority":"重庆市渝中区公安局","birthday":"1999-03-02","cardImg":"/9j/4AAQSkZJRgAB…"

,"spotImg":"/9j/4AAQSkZJRgAB…","threshold":80,"validateType":1,"validdate1":"2001-05-10","validdate2":"2020-05-10"}"

2.1.4.输出参数

返回值名称 类型 必填 参数说明 备注

code int Y 返回码,0成功,非0失败

msg String(1,128) N 返回码描述

返回样例:

{"code":0,"msg":"成功"}

2.2.发送设备心跳

2.2.1.描述

人证合一客户端向平台定时发送设备心跳,通知服务器设备当前的状态。

2.2.2.接口定义

https://ip:port/fvms/api/checkHeartRate

2.2.3.输入参数

参数名称 类型 必填 参数说明 备注

deviceNo String(1,64) Y 设备号

请求样例:

requestData="{"deviceNo":"111111"}"

2.2.4.输出参数

返回值名称 类型 必填 参数说明 备注

code int Y 返回码,0成功,非0失败

msg String(1,128) N 返回码描述

返回样例:

{"code":0,"msg":"成功"}

2.3.设备注册

2.3.1.描述

人证合一客户端向平台发送设备信息,平台将设备添加到数据库中,用于后续维护管理。

2.3.2.接口定义

https://ip:port/fvms/api/regDevice

2.3.3.输入参数

参数名称 类型 必填 参数说明 备注

deviceNo String(1,64) Y 设备号

deviceType smallint (1) Y 设备类型(1:PC 2:安卓)

model String(1,20) Y 型号

system String(1,32) Y 系统

firm String(1,32) Y 厂商

versionNo String(1,20) Y 版本号

请求样例:

requestData="{"deviceNo":"22222","deviceType":2,"firm":"索尼","model":"XD-301","system":"魔神360","versionNo":"1.0.0.001"}"

2.3.4.输出参数

返回值名称 类型 必填 参数说明 备注

code int Y 返回码,0成功,非0失败

msg String(1,128) N 返回码描述

返回样例:

{"code":0,"msg":"成功"}

2.4.获取验证策略

2.4.1.描述

人证合一客户端向平台获取验证策略,用于配置人证比对的参数。

2.4.2.接口定义

https://ip:port/fvms/api/getValidatePolicy

2.4.3.输入参数

参数名称 类型 必填 参数说明 备注

deviceNo String(1,64) Y 设备号

请求样例:

requestData="{"deviceNo":"22222"}"

2.4.4.输出参数

返回值名称 类型 必填 参数说明 备注

code int Y 返回码,0成功,非0失败

msg String(1,128) N 返回码描述

validateType smallint(1) N 验证模式(1:只验人脸 2:人脸或指纹任意通过 3:人脸、指纹同时通过)

threshold smallint(3) N 阈值

fingerStatus smallint(1) N 指纹验证状态(1:开启 2:关闭)

fingerNum smallint(1) N 指纹验证次数

backWelcomeTime smallint(2) N 从“视频界面”退到“欢迎界面”的时间

faceCheckTime smallint(2) N 人脸检测时间

fingerCheckTime smallint(2) N 指纹检测时间

disappearTime smallint(2) N 右侧身份证信息消失的时间

返回样例:

{"backWelcomeTime":99,"code":0,"disappearTime":42,"faceCheckTime":44,"fingerCheckTime":55,"fingerNum":0,"fingerStatus":2,"msg":"成功","threshold":75,"validateType":1}

2.5.获取版本

2.5.1.描述

人证合一客户端向平台获取最新的app版本更新包,用于客户端升级app应用。

2.5.2.接口定义

https://ip:port/fvms/api/getVersion

2.5.3.输入参数

参数名称 类型 必填 参数说明 备注

versionNo String(1,20) Y 版本号(0.0.0.000)

versionType smallint(1) Y 版本类型(1:PC 2:安卓)

请求样例:

requestData="{"versionNo":"2.0.0.000","versionType":2}"

2.5.4.输出参数

返回值名称 类型 必填 参数说明 备注

code int Y 返回码,0成功,非0失败

msg String(1,128) N 响应消息

downloadAddr String(1,128) N 下载地址,只有当获取到最新的版本时,才会返回对应的下载地址

versionNo String(1,20) N 版本号

返回样例:

{"code":0,"downloadAddr":"http://192.168.10.218:82/file/1484125938759_node_exporter-0.13.0.linux-amd64.tar.gz","msg":"成功","versionNo":"2.1.1.444"}

 

 
QQ在线咨询