本協(xié)議主要是為了第三方系統(tǒng)與廣東東信智能科技有限公司手持式身份證驗(yàn)證平臺(tái)通過(guò)Http Post方式進(jìn)行數(shù)據(jù)交互，文檔是面向具備一定的http開(kāi)發(fā)經(jīng)驗(yàn)的開(kāi)發(fā)者。

《智能手持式人證合一驗(yàn)證設(shè)備平臺(tái)接口協(xié)議v0.0.1》

目    錄

1.簡(jiǎn)介1

1.1.Https方式接入1

1.2.面向的讀者1

1.3.返回?cái)?shù)據(jù)1

2.協(xié)議定義1

2.1.上傳人證比對(duì)記錄1

2.1.1.描述1

2.1.2.接口定義1

2.1.3.輸入?yún)?shù)1

2.1.4.輸出參數(shù)2

2.2.發(fā)送設(shè)備心跳2

2.2.1.描述2

2.2.2.接口定義2

2.2.3.輸入?yún)?shù)2

2.2.4.輸出參數(shù)2

2.3.設(shè)備注冊(cè)3

2.3.1.描述3

2.3.2.接口定義3

2.3.3.輸入?yún)?shù)3

2.3.4.輸出參數(shù)3

2.4.獲取驗(yàn)證策略3

2.4.1.描述3

2.4.2.接口定義3

2.4.3.輸入?yún)?shù)3

2.4.4.輸出參數(shù)4

2.5.獲取版本4

2.5.1.描述4

2.5.2.接口定義4

2.5.3.輸入?yún)?shù)4

2.5.4.輸出參數(shù)4

1.簡(jiǎn)介

1.1.Https方式接入

第三方系統(tǒng)與人證合一平臺(tái)通過(guò)Http Post方式進(jìn)行數(shù)據(jù)交互。

本協(xié)議涉及到的中文均采用UTF-8編碼格式，為了顯示美觀數(shù)據(jù)樣本手工加入折行。

1.2.面向的讀者

《人證合一平臺(tái)接口協(xié)議》文檔是面向具備一定的http開(kāi)發(fā)經(jīng)驗(yàn)的開(kāi)發(fā)者。

1.3.返回?cái)?shù)據(jù)

該平臺(tái)提供的接口返回?cái)?shù)據(jù)為json。

2.協(xié)議定義

2.1.上傳人證比對(duì)記錄

2.1.1.描述

人證合一客戶端將比對(duì)記錄上傳到平臺(tái)，平臺(tái)保存比對(duì)記錄用于后續(xù)操作。

2.1.2.接口定義

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

2.1.3.輸入?yún)?shù)

參數(shù)名稱(chēng)類(lèi)型必填參數(shù)說(shuō)明備注

deviceNoString(1,64) Y設(shè)備號(hào)

nameString(1,32)Y姓名

cardnoString(1,18)Y證件號(hào)

cardImgStringY身份證照base64數(shù)據(jù)

spotImgStringY現(xiàn)場(chǎng)照base64數(shù)據(jù)

scoresmallint (3)Y對(duì)比分?jǐn)?shù)

thresholdsmallint (3)Y閾值

validateType

smallint (1)Y驗(yàn)證模式(1：只驗(yàn)人臉 2：人臉或指紋任意通過(guò) 3：人臉、指紋同時(shí)通過(guò))

faceResultsmallint (1)Y人臉比對(duì)結(jié)果（1：成功 2：失敗 3：未檢測(cè)到人臉）

fingerResultsmallint (1)Y指紋比對(duì)結(jié)果（1：成功 2：失敗 3：未檢測(cè)到指紋 4.指紋不檢只驗(yàn)證人臉 4

fingerNumString(3)Y指紋現(xiàn)場(chǎng)比對(duì)次數(shù)(-,0/1 1/1)只驗(yàn)證人臉  -

resultsmallint (1)Y最終結(jié)果（1：成功 2：失敗 3：未檢測(cè)到人臉 4：未檢測(cè)到指紋 ）

folkString(30)Y民族

sexsmallint (1)Y性別（1：男 2：女 3：未知）

birthdayString(10)Y生日

addressString(1,255)Y家庭地址

validdate1String(1,16)Y身份證開(kāi)始有效期

validdate2String(1,16)Y身份證結(jié)束有效期

authorityString(1,128)Y簽發(fā)機(jī)關(guān)

compareDatelongY比對(duì)時(shí)間

請(qǐng)求樣例：

requestData="{"address":"重慶市渝中區(qū)龍華大道","authority":"重慶市渝中區(qū)公安局","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.輸出參數(shù)

返回值名稱(chēng)類(lèi)型必填參數(shù)說(shuō)明備注

codeint Y返回碼，0成功，非0失敗

msgString(1,128) N返回碼描述

返回樣例：

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

2.2.發(fā)送設(shè)備心跳

2.2.1.描述

人證合一客戶端向平臺(tái)定時(shí)發(fā)送設(shè)備心跳，通知服務(wù)器設(shè)備當(dāng)前的狀態(tài)。

2.2.2.接口定義

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

2.2.3.輸入?yún)?shù)

參數(shù)名稱(chēng)類(lèi)型必填參數(shù)說(shuō)明備注

deviceNoString(1,64) Y設(shè)備號(hào)

請(qǐng)求樣例：

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

2.2.4.輸出參數(shù)

返回值名稱(chēng)類(lèi)型必填參數(shù)說(shuō)明備注

codeint Y返回碼，0成功，非0失敗

msgString(1,128) N返回碼描述

返回樣例：

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

2.3.設(shè)備注冊(cè)

2.3.1.描述

人證合一客戶端向平臺(tái)發(fā)送設(shè)備信息，平臺(tái)將設(shè)備添加到數(shù)據(jù)庫(kù)中，用于后續(xù)維護(hù)管理。

2.3.2.接口定義

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

2.3.3.輸入?yún)?shù)

參數(shù)名稱(chēng)類(lèi)型必填參數(shù)說(shuō)明備注

deviceNoString(1,64) Y設(shè)備號(hào)

deviceTypesmallint (1)Y設(shè)備類(lèi)型（1：PC 2：安卓）

modelString(1,20)Y型號(hào)

systemString(1,32)Y系統(tǒng)

firmString(1,32)Y廠商

versionNoString(1,20)Y版本號(hào)

請(qǐng)求樣例：

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

2.3.4.輸出參數(shù)

返回值名稱(chēng)類(lèi)型必填參數(shù)說(shuō)明備注

codeint Y返回碼，0成功，非0失敗

msgString(1,128) N返回碼描述

返回樣例：

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

2.4.獲取驗(yàn)證策略

2.4.1.描述

人證合一客戶端向平臺(tái)獲取驗(yàn)證策略，用于配置人證比對(duì)的參數(shù)。

2.4.2.接口定義

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

2.4.3.輸入?yún)?shù)

參數(shù)名稱(chēng)類(lèi)型必填參數(shù)說(shuō)明備注

deviceNoString(1,64) Y設(shè)備號(hào)

請(qǐng)求樣例：

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

2.4.4.輸出參數(shù)

返回值名稱(chēng)類(lèi)型必填參數(shù)說(shuō)明備注

codeint Y返回碼，0成功，非0失敗

msgString(1,128) N返回碼描述

validateTypesmallint(1)N驗(yàn)證模式(1：只驗(yàn)人臉 2：人臉或指紋任意通過(guò) 3：人臉、指紋同時(shí)通過(guò))

thresholdsmallint(3)N閾值

fingerStatussmallint(1)N指紋驗(yàn)證狀態(tài)（1：開(kāi)啟 2：關(guān)閉）

fingerNumsmallint(1)N指紋驗(yàn)證次數(shù)

backWelcomeTimesmallint(2)N從“視頻界面”退到“歡迎界面”的時(shí)間

faceCheckTimesmallint(2)N人臉檢測(cè)時(shí)間

fingerCheckTimesmallint(2)N指紋檢測(cè)時(shí)間

disappearTimesmallint(2)N右側(cè)身份證信息消失的時(shí)間

返回樣例：

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

2.5.獲取版本

2.5.1.描述

人證合一客戶端向平臺(tái)獲取最新的app版本更新包，用于客戶端升級(jí)app應(yīng)用。

2.5.2.接口定義

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

2.5.3.輸入?yún)?shù)

參數(shù)名稱(chēng)類(lèi)型必填參數(shù)說(shuō)明備注

versionNoString(1,20) Y版本號(hào)(0.0.0.000)

versionTypesmallint(1)Y版本類(lèi)型（1：PC 2：安卓）

請(qǐng)求樣例：

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

2.5.4.輸出參數(shù)

返回值名稱(chēng)類(lèi)型必填參數(shù)說(shuō)明備注

codeint Y返回碼，0成功，非0失敗

msgString(1,128) N響應(yīng)消息

downloadAddrString(1,128)N下載地址，只有當(dāng)獲取到最新的版本時(shí)，才會(huì)返回對(duì)應(yīng)的下載地址

versionNoString(1,20)N版本號(hào)

返回樣例：

{"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"}