本文介紹調用風險識別API時使用的公用請求參數和公用返回參數。
公用請求參數
風險識別API介面的入參數包含公用請求參數和具體服務事件參數,公用請求參數是指每一個介面都需要使用到的參數,以下表格是公用請求參數的詳細介紹。
名稱 | 類型 | 是否必須 | 描述 |
名稱 | 類型 | 是否必須 | 描述 |
Format | String | 是 | 返回訊息的格式。取值:
|
Version | String | 是 | API版本號碼,使用YYYY-MM-DD日期格式,本版本對應為2019-05-21。 |
AccessKeyId | String | 是 | 阿里雲頒發給使用者的訪問服務所用的密鑰ID。 |
Signature | String | 是 | 簽名結果串,關於簽名的計算方法,請參見簽名機制SDK方式調用第2.0節。 |
SignatureMethod | String | 是 | 簽名方式,目前支援HMAC-SHA1。 |
Timestamp | String | 是 | 請求的時間戳記。日期格式按照ISO8601標準表示,並需要使用UTC時間。格式為:yyyy-MM-ddTHH:mm:ssZ。例如,北京時間2019年8月22日09點44分35秒錶示為2019-08-22T01:44:35Z。 |
SignatureVersion | String | 是 | 簽名演算法版本,取值為1.0。 |
SignatureNonce | String | 是 | 唯一隨機數,用於防止網路重放攻擊。不同請求要使用不同的隨機數值。 |
Action | String | 是 | 如調用決策引擎:RequestDecision 如調用情境風控:ExecuteRequestSG |
Service | String | 是 |
|
ServiceParameters | String | 是 | 服務參數列表的JSON格式為 |
以下是裝置風險識別-增強版服務的請求參數樣本:
https://saf.{region}.aliyuncs.com/
?Format=JSON
&Version=2020-07-06
&Signature=vpEEL0zFHfxXYzSFV0n7%2FZiFL9o%3D
&SignatureMethod=Hmac-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&Action=ExecuteRequest
&AccessKeyId=123****saf
&Timestamp=2018-06-01T12:00:00Z
&Service=device_risk_pro
&ServiceParameters={"deviceToken":1012****}
公用返回參數
您發送的每次介面調用請求,無論成功與否,系統都會返回唯一識別碼RequestId。其他返回參數包含score(分數)、tags(標籤)、extend(自訂返回參數),服務不同返回的參數不同,詳見具體服務對應的文檔。
以下是裝置風險識別-增強版服務返回參數的JSON
樣本:
{
//service:device_risk_pro
"RequestId": "52E3208D-E7BF-32F0-9913-2A168894D2D9",
"Message": "OK",
"Data": {
"extend": "0f533f6056f50664b48f2b3866220f0f", //Unique device ID
"tags": "is_rooted", //Reason code
"score":""
},
"Code": 200 //Request succeed
}
本文中的返回樣本為了便於閱讀,做了格式化處理,實際返回結果沒有進行換行、縮排等格式化處理。
錯誤碼
Code | 含義描述 |
Code | 含義描述 |
200 | 請求成功。 |
400 | ServiceParameters(事件參數)不合法。 |
402 | QPS超過已購規格,限流。 |
403 | 許可權不足,服務未開通或已到期。 |
404 | Service(服務參數)不合法。 |
500 | 內部伺服器錯誤。 |