En este documento, se muestra 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
que uses v1
, ya que las funciones nuevas, como el defensor de cuentas de reCAPTCHA Enterprise,
solo están disponibles en v1
. v1
admite la autenticación de la cuenta de servicio y la clave de API.
Para migrar tus llamadas de evaluación de v1beta1
a v1
, haz lo siguiente:
Reemplaza las llamadas para crear evaluaciones.
Reemplaza
https://recaptchaenterprise.googleapis.com/v1beta1/projects/PROJECT_ID/assessments?key=API_KEY
porhttps://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/assessments?key=API_KEY
.Comprende los cambios en la respuesta JSON de la evaluación:
Cuando usas
v1
, los camposreasons
yscore
se encapsulan enriskAnalysis
en la respuesta y, cuando usasv1beta1
, los camposreasons
yscore
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) } }
Actualiza tu entorno a fin de usar los campos
reasons
yscore
de la respuesta JSON parav1
.En el siguiente código de muestra, se muestran los campos que se usan a partir de la respuesta de
v1
yv1beta1
: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) ) .... ....
Reemplaza las llamadas para anotar las evaluaciones.
Reemplaza
https://recaptchaenterprise.googleapis.com/v1beta1/projects/PROJECT_ID/assessments}:annotate
porhttps://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/assessments}:annotate
.Si actualmente registras tus llamadas a las APIs de
create
yannotate
mediante el registro de auditoría, se recomienda usar el registro de plataforma (disponible solo parav1
).