東信EST-M20手持人證合一平臺接口協(xié)議V0.0.2
目 錄
1. 簡介
1.1. Https方式接入
第三方系統(tǒng)與人證合一平臺通過Http Post方式進行數(shù)據(jù)交互。
本協(xié)議涉及到的中文均采用UTF-8編碼格式，為了顯示美觀數(shù)據(jù)樣本手工加入折行。
1.2. 面向的讀者
《人證合一平臺接口協(xié)議》文檔是面向具備一定的http開發(fā)經驗的開發(fā)者。
1.3. 返回數(shù)據(jù)
該平臺提供的接口返回數(shù)據(jù)為json。
2. 協(xié)議定義
2.1. 上傳人證比對記錄
2.1.1. 描述
人證合一客戶端將比對記錄上傳到平臺，平臺保存比對記錄用于后續(xù)操作。
2.1.2. 接口定義
https://ip:port/fvms/api/uploadCmpRecord
2.1.3. 輸入參數(shù)
參數(shù)名稱 | 類型 | 必填 | 參數(shù)說明 | 備注 |
deviceNo | String(1,64) | Y | 設備號 | |
name | String(1,32) | Y | 姓名 | |
cardno | String(1,18) | Y | 身份證號碼 | |
cardImg | String | Y | 身份證照base64數(shù)據(jù) | |
spotImg | String | Y | 現(xiàn)場照base64數(shù)據(jù) | |
score | smallint (3) | Y | 對比分數(shù) | |
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 | 指紋現(xiàn)場比對次數(shù)(-,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 | 簽發(fā)機關 | |
compareDate | long | Y | 比對時間 |
請求樣例：
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ù)
返回值名稱 | 類型 | 必填 | 參數(shù)說明 | 備注 |
code | int | Y | 返回碼，0成功，非0失敗 | |
msg | String(1,128) | N | 返回碼描述 |
返回樣例：
{"code":0,"msg":"成功"}
