Zur v1 API migrieren

In diesem Dokument erfahren Sie, wie Sie von der v1beta1-Version zur v1 migrieren Version der reCAPTCHA Enterprise API.

Wenn Sie v1beta1 zum Erstellen und Annotieren von Bewertungen verwenden, empfehlen wir v1, da die neuen Funktionen wie reCAPTCHA Account Defender nur in v1 verfügbar sind. v1 unterstützt sowohl die API-Schlüssel- als auch die Dienstkontoauthentifizierung.

So migrieren Sie Ihre Bewertungsaufrufe von v1beta1 zu v1:

  1. Ersetzen Sie Aufrufe, um Bewertungen zu erstellen.

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

  2. Änderungen in der JSON-Antwort der Bewertung:

    Wenn Sie v1 verwenden, werden die Felder reasons und score in riskAnalysis in der Antwort verwenden. Wenn Sie v1beta1 verwenden, werden reasons und score-Felder werden nicht in die Antwort gekapselt.

    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. Aktualisieren Sie Ihre Umgebung, um die Felder reasons und score aus der JSON-Antwort für zu verwenden. v1

    Im folgenden Codebeispiel sind die Felder zu sehen, die aus der Antwort von v1 und v1beta1 verwendet werden:

    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. Ersetzen Sie Aufrufe zum Annotieren von Bewertungen.

    https://recaptchaenterprise.googleapis.com/v1beta1/projects/PROJECT_ID/assessments}:annotate durch https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/assessments}:annotate ersetzen

  5. Wenn Sie Ihre create- und annotate-API-Aufrufe derzeit mithilfe von Audit-Logs erfassen, sollten Sie stattdessen Plattform-Logs verwenden (nur für v1 verfügbar).

Nächste Schritte