Migrar a la API de v1

En este documento, se explica cómo migrar de la versión v1beta1 a la versión v1 de la API de reCAPTCHA Enterprise.

Si usas v1beta1 para crear y anotar evaluaciones, te recomendamos usar v1, ya que las funciones nuevas, como reCAPTCHA account defender, solo están disponibles en v1. v1 admite la autenticación de claves de API y de cuenta de servicio.

Para migrar tus llamadas de evaluación de v1beta1 a v1, haz lo siguiente:

  1. Reemplaza las llamadas para crear evaluaciones.

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

  2. Comprende los cambios en la respuesta JSON de la evaluación:

    Cuando usas v1, los campos reasons y score se encapsulan en riskAnalysis en la respuesta, y cuando usas v1beta1, los campos reasons y score no se encapsulan en la respuesta.

    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. Actualiza tu entorno para usar los campos reasons y score de la respuesta JSON de v1

    En el siguiente código de muestra, se muestran los campos que se usan de la respuesta de v1 y 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. Reemplaza las llamadas para anotar evaluaciones.

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

  5. Si actualmente registras tus llamadas a las APIs de create y annotate con registro de auditoría que se recomienda usar registro de plataforma (disponible solo para v1).

¿Qué sigue?