遷移至 v1 API

本文說明如何從 v1beta1 版本遷移至 reCAPTCHA Enterprise API 的 v1 版本。

如要將評估呼叫從 v1beta1 遷移至 v1，請按照下列步驟操作：

  1. 取代建立評估作業的呼叫。

    以 https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/assessments?key=API_KEY 取代 https://recaptchaenterprise.googleapis.com/v1beta1/projects/PROJECT_ID/assessments?key=API_KEY

  2. 瞭解評估的 JSON 回應有何變更：

    使用 v1 時，reasons 和 score 欄位會封裝在回應中的 riskAnalysis 內；使用 v1beta1 時，reasons 和 score 欄位不會封裝在回應中。

    v1

    {
"event":{
  "expectedAction":"EXPECTED_ACTION",
  "hashedAccountId":"ACCOUNT_ID",
  "siteKey":"KEY_ID",
  "token":"TOKEN",
  "userAgent":"(USER-PROVIDED STRING)",
  "userIpAddress":"USER_PROVIDED_IP_ADDRESS"
},
"name":"ASSESSMENT_ID",
 "riskAnalysis":{
  "reasons":[],
  "score":"SCORE
},
"tokenProperties":{
  "action":"USER_INTERACTION",
  "createTime":"TIMESTAMP",
  "hostname":"HOSTNAME",
  "invalidReason":"(ENUM)",
  "valid":(BOOLEAN)
}
}

    v1beta1

    {
"event":{
  "expectedAction":"EXPECTED_ACTION",
  "hashedAccountId":"ACCOUNT_ID",
  "siteKey":"KEY_ID",
  "token":"TOKEN",
  "userAgent":"(USER-PROVIDED STRING)",
  "userIpAddress":"USER_PROVIDED_IP_ADDRESS"
},
"name":"ASSESSMENT_ID",
"reasons":[],
"score":"SCORE",

"tokenProperties":{
  "action":"USER_INTERACTION",
  "createTime":"TIMESTAMP",
  "hostname":"HOSTNAME",
  "invalidReason":"(ENUM)",
  "valid":(BOOLEAN)
}
}

  3. 更新環境，使用 v1 的 JSON 回應中的 reasons 和 score 欄位。

    下列程式碼範例顯示 v1 和 v1beta1 回應中使用的欄位：

    v1

    .....
.....
# Get the risk score and the reason(s)
for reason in response.risk_analysis.reasons:
    print(reason)
print(
    "The reCAPTCHA score for this token is: "
    + str(response.risk_analysis.score)
)
....
....

    v1beta1

    .....
.....
# Get the risk score and the reason(s)
for reason in response.reasons:
    print(reason)
print(
    "The reCAPTCHA score for this token is: "
    + str(response.score)
)
....
....

  4. 取代用於為評估作業加註的呼叫。

    以 https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/assessments}:annotate 取代 https://recaptchaenterprise.googleapis.com/v1beta1/projects/PROJECT_ID/assessments}:annotate

  5. 如果您目前使用稽核記錄記錄 create 和 annotate API 呼叫，建議使用平台記錄 (僅適用於 v1)。

後續步驟