Migrazione all'API v1

Questo documento mostra come eseguire la migrazione dalla versione v1beta1 alla versione v1 dell'API reCAPTCHA Enterprise.

Se utilizzi v1beta1 per creare e annotare valutazioni, ti consigliamo di utilizzare v1 perché le nuove funzionalità, come il parametro di difesa dell'account reCAPTCHA Enterprise, sono disponibili solo su v1. v1 supporta sia l'autenticazione tramite chiave API sia l'autenticazione dell'account di servizio.

Per eseguire la migrazione delle chiamate di valutazione da v1beta1 a v1, segui questi passaggi:

  1. Sostituisci le chiamate per creare valutazioni.

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

  2. Comprendi le modifiche nella risposta JSON della valutazione:

    Quando utilizzi v1, i campi reasons e score sono incapsulati in riskAnalysis e quando utilizzi v1beta1, i campi reasons e score non sono incapsulati nella risposta.

    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. Aggiorna il tuo ambiente per utilizzare i campi reasons e score dalla risposta JSON per v1.

    Il seguente codice di esempio mostra i campi utilizzati nella risposta di 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. Sostituisci le chiamate per annotare le valutazioni.

    Sostituisci https://recaptchaenterprise.googleapis.com/v1beta1/projects/PROJECT_ID/assessments}:annotate con https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/assessments}:annotate

Passaggi successivi