Migrazione all'API v1

Questo documento illustra come eseguire la migrazione dalla versione v1beta1 alla versione v1 dell'API reCAPTCHA Enterprise.

Se utilizzi v1beta1 per creare e annotare le valutazioni, ti consigliamo di utilizzare v1 perché le nuove funzionalità, come reCAPTCHA Account Defender, sono disponibili solo su v1. v1 supporta sia l'autenticazione tramite chiave API sia l'autenticazione tramite account di servizio.

Per eseguire la migrazione delle chiamate di valutazione da v1beta1 a v1:

  1. Sostituisci le chiamate per creare valutazioni.

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

  2. Comprendi le modifiche nella risposta JSON della valutazione:

    Quando utilizzi v1, i campi reasons e score sono incapsulati in riskAnalysis nella risposta e, quando utilizzi v1beta1, i campireasons e score non sono incapsulati nella risposta.

    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. Aggiorna l'ambiente per utilizzare i campi reasons e score della risposta JSON per v1.

    Il seguente codice di esempio mostra i campi utilizzati dalla risposta di v1 e 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. Sostituisci le chiamate per annotare le valutazioni.

    Sostituisci https://recaptchaenterprise.googleapis.com/v1beta1/projects/PROJECT_ID/assessments}:annotate con https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/assessments}:annotate

  5. Se al momento registri le chiamate API create e annotate utilizzando gli audit log, ti consigliamo di utilizzare i log della piattaforma (disponibile solo per v1).

Passaggi successivi