人臉核身 - API文檔

1、接口概要

1.1 文檔說明

本文檔主要提供給互億平臺的用戶對接接口的使用說明，開發(fā)者可以利用互億無線提供的 HTTP 接口，調(diào)用互億無線的人臉核身服務(wù)。

1.2 提交方式

GET / POST

1.3 加密方式

1、采用HTTPS協(xié)議提交請求
2、通過MD5動態(tài)簽名方式加密

1.4 API ID / API KEY

登錄用戶中心，進入“產(chǎn)品與服務(wù) -》 認(rèn)證核驗 -》身份信息核驗”，在【產(chǎn)品總覽】頁面右側(cè)，如下圖所示：

2、提交認(rèn)證

2.1 接口描述

通過POST、GET方式進行提交，數(shù)據(jù)編碼采用utf-8格式，支持24小時全天提交。
內(nèi)容格式為：Content-Type: application/x-www-form-urlencoded

2.2 請求地址

https://api.ihuyi.com/idcard/idface/Submit.json

2.3 請求參數(shù)

2.4 響應(yīng)示例

示例（成功）

{"code":2,"msg":"提交成功","idcardid":"16236437872836","result":{"expire": "1750918770965","url":"", "faceToken":"c02008be0a764c7e8f36d9c78773c6f5"}}

示例（失敗）

{"code":405,"msg":"用戶名或密碼不正確","idcardid":"0","result":{"status":"","url":"", "faceToken":""}}

2.5 響應(yīng)參數(shù)

2.6 GET請求示例

https://api.ihuyi.com/idcard/idface/Submit.json?account=APIID&password=APIKEY&name=姓名&id_card_no=401123343333xxxxxxxxxxxxxx&faceType=H5&callbackUrl=http://xxx.com/xxx

3、余額查詢

3.1 接口描述

通過接口可以方便的查詢你的賬戶剩余條數(shù)。
內(nèi)容格式為：Content-Type: application/x-www-form-urlencoded

3.2 請求地址

https://api.ihuyi.com/idcard/idface/GetNum.json

3.3 請求參數(shù)

用戶通過http 或 https提交請求到服務(wù)器后，服務(wù)器會返回一串json格式的字符串，GetNumResult結(jié)構(gòu)說明如下：

3.4 響應(yīng)示例

示例（成功）

{"code":2,"msg":"查詢成功","num":123}

示例（失?。?/p>

{"code":405,"msg":"用戶名或密碼不正確","num":0}

3.5 響應(yīng)參數(shù)

3.6 GET請求示例

https://api.ihuyi.com/idcard/idface/GetNum.json?account=APIID&password=APIKEY

4、認(rèn)證結(jié)果查詢

4.1 接口描述

通過接口可以方便的查詢認(rèn)證的結(jié)果。

內(nèi)容格式為：Content-Type: application/x-www-form-urlencoded

4.2 請求地址

https://api.ihuyi.com/idcard/idface/GetResult.json

4.3 請求參數(shù)

用戶通過http 或 https提交請求到服務(wù)器后，服務(wù)器會返回一串json格式的字符串，GetResultResult結(jié)構(gòu)說明如下：

4.4 響應(yīng)示例

示例（成功）

{"code":2,"msg":"查詢成功","reslut":{"status":"ING","message":"認(rèn)證成功","livingScore":"100","similarity":"100"}}

示例（失敗）

{"code":405,"msg":"用戶名或密碼不正確"}

4.5 響應(yīng)參數(shù)

4.6 GET請求示例

https://api.ihuyi.com/idcard/idface/GetResult.json?account=APIID&password=APIKEY&idcardid=25062613492951372

5、認(rèn)證結(jié)果推送

5.1 接口描述

用戶先提供數(shù)據(jù)接收地址，然后綁定到互億無線系統(tǒng)后臺，平臺會以POST方式實時的將回執(zhí)信息推送到此地址，內(nèi)容格式為：Content-Type: application/x-www-form-urlencoded。

5.2 推送參數(shù)

注意：
成功接收請輸出字符 “success”（不包含引號）結(jié)束推送，否則以接收失敗處理。每個回執(zhí)最多推送 3 次。每次間隔疊加 60 秒。

6、生成動態(tài)密碼方式

以PHP為例，提交認(rèn)證的生成方式：

$time = time();
$password = md5($account.$apikey.$app.$name.$id_card_no.$time);

示例：

APIID： test
APIKEY：1q784322ba1******
app：idface
name：張三
id_card_no：40122111******
time：1651544941
結(jié)果：$password = md5("test1q784322ba1******idface張三40122111******1651544941");

注意：所以字符編碼統(tǒng)一為UTF-8

查詢剩余條數(shù)的生成方式：

$time = time();
$password = md5($account.$apikey.$app.$time);

示例：

APIID： test
APIKEY：1q784322ba1******
app：idface
time：1651544941
結(jié)果：$password = md5("test1q784322ba1******idface1651544941");

認(rèn)證結(jié)果查詢的生成方式：

$time = time();
$password = md5($account.$apikey.$app.$time);

示例：

APIID： test
APIKEY：1q784322ba1******
app：idface
time：1651544941
結(jié)果：$password = md5("test1q784322ba1******idface1651544941");

Unix時間戳參考地址：http://tool.chinaz.com/Tools/unixtime.aspx

7、如何實現(xiàn)UNIX時間戳

8、SDK對接

SDK資源下載