מעבר לגרסה v1 של API

במאמר הזה מוסבר איך לבצע מיגרציה מגרסה v1beta1 לגרסה v1 של reCAPTCHA Enterprise API.

החל מיוני 2026, נקודת הקצה v1beta1 תיסגר בהדרגה. > במהלך ההשבתה ההדרגתית הזו, בקשות שיישלחו לנקודת הקצה v1beta1 משירותים שלא בוצע בהם מעבר יתחילו להחזיר שגיאות.

כדי להעביר את השיחות שלכם להערכה מ-v1beta1 אל v1, צריך לבצע את הפעולות הבאות:

  1. החלפת שיחות כדי ליצור מבחנים.

    מחליפים את https://recaptchaenterprise.googleapis.com/v1beta1/projects/PROJECT_ID/assessments?key=API_KEY ב-https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/assessments?key=API_KEY

  2. הבנת השינויים בתגובת ה-JSON של ההערכה:

    כשמשתמשים ב-v1, השדות reasons ו-score מופיעים בתוך riskAnalysis בתשובה, וכשמשתמשים ב-v1beta1, השדות reasons ו-score לא מופיעים בתוך riskAnalysis בתשובה.

    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. מעדכנים את הסביבה כך שישתמשו בשדות reasons ו-score מהתגובה בפורמט JSON עבור v1.

    בדוגמת הקוד הבאה מוצגים השדות שבהם נעשה שימוש בתגובה של v1 ושל 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. החלפת קריאות לסימון הערכות.

    מחליפים את https://recaptchaenterprise.googleapis.com/v1beta1/projects/PROJECT_ID/assessments}:annotate ב-https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/assessments}:annotate

  5. אם אתם מתעדים כרגע את הקריאות ל-API של create ושל annotate באמצעות תיעוד ביקורת, מומלץ להשתמש בתיעוד פלטפורמה (זמין רק ב-v1).

המאמרים הבאים