Migrar para a API v1

Este documento mostra como migrar da versão v1beta1 para a v1 da API reCAPTCHA Enterprise.

Se você estiver usando v1beta1 para criar e anotar avaliações, recomendamos usar v1, porque os novos recursos, como o reCAPTCHA Account Defender, estão disponíveis apenas em v1. O v1 oferece suporte à chave de API e à autenticação de conta de serviço.

Para migrar suas chamadas de avaliação de v1beta1 para v1, faça o seguinte:

  1. Substitua ligações para criar avaliações.

    Substitua 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. Entenda as mudanças na resposta JSON da avaliação:

    Quando você usa v1, os campos reasons e score são encapsulados em riskAnalysis na resposta. Quando você usa v1beta1, os campos reasons e score não são encapsulados na resposta.

    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. Atualize seu ambiente para usar os campos reasons e score da resposta JSON para v1.

    O exemplo de código abaixo mostra os campos usados na resposta de 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. Substitua as chamadas para anotar avaliações.

    Substitua https://recaptchaenterprise.googleapis.com/v1beta1/projects/PROJECT_ID/assessments}:annotate por https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/assessments}:annotate.

  5. Se você estiver registrando suas chamadas de API create e annotate usando registros de auditoria, recomendamos usar registros de plataforma (disponível apenas para v1).

A seguir