手持式人證合一驗證設備平臺接口協議v0.0.1
本協議主要是為了第三方系統與廣東東信智能科技有限公司手持式身份證驗證平臺通過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.輸入參數
參數名稱類型必填參數說明備注
deviceNoString(1,64) Y設備號
nameString(1,32)Y姓名
cardnoString(1,18)Y證件號
cardImgStringY身份證照base64數據
spotImgStringY現場照base64數據
scoresmallint (3)Y對比分數
thresholdsmallint (3)Y閾值
validateType
smallint (1)Y驗證模式(1：只驗人臉 2：人臉或指紋任意通過 3：人臉、指紋同時通過)
faceResultsmallint (1)Y人臉比對結果（1：成功 2：失敗 3：未檢測到人臉）
fingerResultsmallint (1)Y指紋比對結果（1：成功 2：失敗 3：未檢測到指紋 4.指紋不檢只驗證人臉 4
fingerNumString(3)Y指紋現場比對次數(-,0/1 1/1)只驗證人臉 -
resultsmallint (1)Y最終結果（1：成功 2：失敗 3：未檢測到人臉 4：未檢測到指紋 ）
folkString(30)Y民族
sexsmallint (1)Y性別（1：男 2：女 3：未知）
birthdayString(10)Y生日
addressString(1,255)Y家庭地址
validdate1String(1,16)Y身份證開始有效期
validdate2String(1,16)Y身份證結束有效期
authorityString(1,128)Y簽發機關
compareDatelongY比對時間
請求樣例：
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.輸出參數
返回值名稱類型必填參數說明備注
codeint Y返回碼，0成功，非0失敗
msgString(1,128) N返回碼描述
返回樣例：
{"code":0,"msg":"成功"}
2.2.發送設備心跳
2.2.1.描述
人證合一客戶端向平臺定時發送設備心跳，通知服務器設備當前的狀態。
2.2.2.接口定義
https://ip:port/fvms/api/checkHeartRate
2.2.3.輸入參數
參數名稱類型必填參數說明備注
deviceNoString(1,64) Y設備號
請求樣例：
requestData="{"deviceNo":"111111"}"
2.2.4.輸出參數
返回值名稱類型必填參數說明備注
codeint Y返回碼，0成功，非0失敗
msgString(1,128) N返回碼描述
返回樣例：
{"code":0,"msg":"成功"}
2.3.設備注冊
2.3.1.描述
人證合一客戶端向平臺發送設備信息，平臺將設備添加到數據庫中，用于后續維護管理。
2.3.2.接口定義
https://ip:port/fvms/api/regDevice
2.3.3.輸入參數
參數名稱類型必填參數說明備注
deviceNoString(1,64) Y設備號
deviceTypesmallint (1)Y設備類型（1：PC 2：安卓）
modelString(1,20)Y型號
systemString(1,32)Y系統
firmString(1,32)Y廠商
versionNoString(1,20)Y版本號
請求樣例：
requestData="{"deviceNo":"22222","deviceType":2,"firm":"索尼","model":"XD-301","system":"魔神360","versionNo":"1.0.0.001"}"
2.3.4.輸出參數
返回值名稱類型必填參數說明備注
codeint Y返回碼，0成功，非0失敗
msgString(1,128) N返回碼描述
返回樣例：
{"code":0,"msg":"成功"}
2.4.獲取驗證策略
2.4.1.描述
人證合一客戶端向平臺獲取驗證策略，用于配置人證比對的參數。
2.4.2.接口定義
https://ip:port/fvms/api/getValidatePolicy
2.4.3.輸入參數
參數名稱類型必填參數說明備注
deviceNoString(1,64) Y設備號
請求樣例：
requestData="{"deviceNo":"22222"}"
2.4.4.輸出參數
返回值名稱類型必填參數說明備注
codeint Y返回碼，0成功，非0失敗
msgString(1,128) N返回碼描述
validateTypesmallint(1)N驗證模式(1：只驗人臉 2：人臉或指紋任意通過 3：人臉、指紋同時通過)
thresholdsmallint(3)N閾值
fingerStatussmallint(1)N指紋驗證狀態（1：開啟 2：關閉）
fingerNumsmallint(1)N指紋驗證次數
backWelcomeTimesmallint(2)N從“視頻界面”退到“歡迎界面”的時間
faceCheckTimesmallint(2)N人臉檢測時間
fingerCheckTimesmallint(2)N指紋檢測時間
disappearTimesmallint(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.輸入參數
參數名稱類型必填參數說明備注
versionNoString(1,20) Y版本號(0.0.0.000)
versionTypesmallint(1)Y版本類型（1：PC 2：安卓）
請求樣例：
requestData="{"versionNo":"2.0.0.000","versionType":2}"
2.5.4.輸出參數
返回值名稱類型必填參數說明備注
codeint Y返回碼，0成功，非0失敗
msgString(1,128) N響應消息
downloadAddrString(1,128)N下載地址，只有當獲取到最新的版本時，才會返回對應的下載地址
versionNoString(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"}
產品咨詢