Zur v1 API migrieren

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

So migrieren Sie Ihre Bewertungsaufrufe von v1beta1 zu v1:

  1. Ersetzen Sie Aufrufe zum Erstellen von Bewertungen.

    Ersetzen Sie https://recaptchaenterprise.googleapis.com/v1beta1/projects/PROJECT_ID/assessments?key=API_KEY durch https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/assessments?key=API_KEY.

  2. Informationen zu den Änderungen in der JSON-Antwort der Bewertung:

    Wenn Sie v1 verwenden, sind die Felder reasons und score in der Antwort in riskAnalysis gekapselt. Wenn Sie v1beta1 verwenden, sind die Felderreasons und score in der Antwort nicht 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 v1 zu verwenden.

    Im folgenden Beispielcode werden die Felder aus der Antwort von v1 und v1beta1 gezeigt:

    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 Kommentieren von Bewertungen.

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

  5. Wenn Sie Ihre create und annotate API-Aufrufe derzeit mit Audit-Logging protokollieren, empfehlen wir die Verwendung des Plattform-Loggings (nur für v1 verfügbar).

Nächste Schritte