Zur v1 API migrieren

In diesem Dokument wird erläutert, wie du von der v1beta1-Version auf die v1-Version der reCAPTCHA Enterprise API migrieren kannst.

Wenn Sie Bewertungen mit v1beta1 erstellen und annotieren, sollten Sie v1 verwenden, da die neuen Funktionen wie reCAPTCHA Enterprise Account Defender nur unter v1 verfügbar sind. v1 unterstützt sowohl den API-Schlüssel als auch die Dienstkontoauthentifizierung.

So migrieren Sie Ihre Prüfungsaufrufe von v1beta1 zu v1:

  1. Ersetzen Sie Aufrufe, um Bewertungen zu erstellen.

    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. So verstehen Sie die Änderungen an der JSON-Antwort der Bewertung:

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

    v1

    {
    "event":{
      "expectedAction":"EXPECTED_ACTION",
      "hashedAccountId":"ACCOUNT_ID",
      "siteKey":"SITE_KEY",
      "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":"SITE_KEY",
      "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.

    Der folgende Beispielcode zeigt die Felder, die in 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, um Bewertungen mit Anmerkungen zu versehen.

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

Weitere Informationen