Bermigrasi ke API v1

Dokumen ini menunjukkan cara bermigrasi dari versi v1beta1 ke versi v1 reCAPTCHA Enterprise API.

Untuk memigrasikan panggilan penilaian dari v1beta1 ke v1, lakukan hal berikut:

  1. Mengganti panggilan untuk membuat penilaian.

    Ganti https://recaptchaenterprise.googleapis.com/v1beta1/projects/PROJECT_ID/assessments?key=API_KEY dengan https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/assessments?key=API_KEY

  2. Memahami perubahan dalam respons JSON penilaian:

    Saat Anda menggunakan v1, kolom reasons dan score dienkapsulasi dalam riskAnalysis dalam respons, dan saat Anda menggunakan v1beta1, kolom reasons dan score tidak dienkapsulasi dalam respons.

    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. Perbarui lingkungan Anda untuk menggunakan kolom reasons dan score dari respons JSON untuk v1.

    Contoh kode berikut menunjukkan kolom yang digunakan dari respons v1 dan 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. Mengganti panggilan untuk memberi anotasi pada penilaian.

    Ganti https://recaptchaenterprise.googleapis.com/v1beta1/projects/PROJECT_ID/assessments}:annotate dengan https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/assessments}:annotate

  5. Jika saat ini Anda mencatat panggilan API create dan annotate menggunakan audit logging, sebaiknya gunakan platform logging (hanya tersedia untuk v1).

Langkah berikutnya