v1 API로 마이그레이션

이 문서에서는 reCAPTCHA Enterprise API의 v1beta1 버전에서 v1 버전으로 마이그레이션하는 방법을 보여줍니다.

v1beta1을 사용하여 평가를 만들고 평가에 주석을 추가하는 경우 v1에서만 reCAPTCHA 계정 방어 도구와 같은 새 기능을 사용할 수 있으므로 v1을 사용하는 것이 좋습니다. v1에서는 API 키와 서비스 계정 인증 모두 지원합니다.

평가 호출을 v1beta1에서 v1로 마이그레이션하려면 다음을 수행합니다.

호출을 바꿔 평가를 만듭니다.

https://recaptchaenterprise.googleapis.com/v1beta1/projects/PROJECT_ID/assessments?key=API_KEY를 https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/assessments?key=API_KEY로 바꿉니다.

참고: 동일한 API 키를 사용할 수 있습니다.

평가의 JSON 응답 변경사항을 이해합니다.

v1을 사용하면 reasons 필드와 score 필드가 응답의 riskAnalysis에 캡슐화되고 v1beta1을 사용하면 reasons 필드와 score 필드는 응답에 캡슐화되지 않습니다.

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)
}
}

환경이 v1에 대한 JSON 응답에서 reasons 필드와 score 필드를 사용하도록 업데이트합니다.

다음 샘플 코드에서는 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)
)
....
....

호출을 바꿔 평가에 주석을 추가합니다.

https://recaptchaenterprise.googleapis.com/v1beta1/projects/PROJECT_ID/assessments}:annotate를 https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/assessments}:annotate로 바꿉니다.
현재 감사 로깅을 사용하여 create 및 annotate API 호출을 로깅하는 경우 플랫폼 로깅을 사용하는 것이 좋습니다(v1에서만 사용 가능).

v1 API로 마이그레이션

v1

v1beta1

v1

v1beta1

다음 단계