Migrer vers API v1

Ce document explique comment passer de la version v1beta1 à la version v1 de l'API reCAPTCHA Enterprise.

Si vous utilisez v1beta1 pour créer et annoter des évaluations, nous vous recommandons d'utiliser v1, car les nouvelles fonctionnalités, telles que le défenseur de compte reCAPTCHA, ne sont disponibles que sur v1. v1 est compatible avec l'authentification par clé API et par compte de service.

Pour migrer vos appels d'évaluation de v1beta1 vers v1, procédez comme suit:

  1. Remplacez les appels pour créer des évaluations.

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

  2. Comprendre les modifications apportées à la réponse JSON de l'évaluation:

    Lorsque vous utilisez v1, les champs reasons et score sont encapsulés dans riskAnalysis dans la réponse. Lorsque vous utilisez v1beta1, les champs reasons et score ne sont pas encapsulés dans la réponse.

    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. Mettez à jour votre environnement pour utiliser les champs reasons et score de la réponse JSON pour v1.

    L'exemple de code suivant montre les champs utilisés à partir de la réponse de v1 et 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. Remplacez les appels permettant d'annoter les évaluations.

    Remplacez https://recaptchaenterprise.googleapis.com/v1beta1/projects/PROJECT_ID/assessments}:annotate par https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/assessments}:annotate.

  5. Si vous enregistrez actuellement vos appels d'API create et annotate à l'aide de la journalisation d'audit, nous vous recommandons d'utiliser la journalisation de la plate-forme (disponible pour v1 uniquement).

Étape suivante