迁移后使用 reCAPTCHA Enterprise 功能

本页面介绍在从非 Enterprise 版 reCAPTCHA 迁移后,如何修改现有 reCAPTCHA 集成以使用 reCAPTCHA Enterprise 功能(例如多重身份验证 (MFA) 和密码泄露检测)。修改现有 reCAPTCHA 集成涉及对网页进行插桩处理和迁移后端调用。

准备工作

迁移到 reCAPTCHA Enterprise

对网页进行插桩

要使用 reCAPTCHA Enterprise 脚本和调用对网页进行插桩处理,请执行以下操作:

  1. 验证您的网页中是否包含以下脚本:https://www.google.com/recaptcha/api.js
  2. 在您的网页中,将 https://www.google.com/recaptcha/api.js 替换为 https://www.google.com/recaptcha/enterprise.js

  3. 如果您以编程方式调用 API,请替换以下调用:

    • grecaptcha.execute() -> grecaptcha.enterprise.execute()
    • grecaptcha.getResponse() -> grecaptcha.enterprise.getResponse()
    • grecaptcha.ready() -> grecaptcha.enterprise.ready()
    • grecaptcha.render() -> grecaptcha.enterprise.render()
    • grecaptcha.reset() -> grecaptcha.enterprise.reset()

(可选)如需提高 reCAPTCHA Enterprise 的加载性能,请执行以下操作:

  1. 验证您是否是异步加载 enterprise.js。如需了解详情,请参阅异步加载 reCAPTCHA

  2. 在加载 enterprise.js 的页面 <head> 标记中添加以下资源提示:

    • <link rel="preconnect" href="https://www.google.com">
    • <link rel="preconnect" href="https://www.gstatic.com" crossorigin>

迁移后端调用

要使用 reCAPTCHA Enterprise 功能,您必须将后端调用迁移到新端点并设置身份验证:

  1. 将对 https://www.google.com/recaptcha/api/siteverify 的后端调用替换为对 recaptchaenterprise.googleapis.com 的等效调用。如需了解完整网址和 POST 数据格式,请参阅为网站创建评估

  2. 设置向 reCAPTCHA Enterprise 进行的身份验证。

    您选择的身份验证方法取决于设置 reCAPTCHA Enterprise 的环境。下表可帮助您选择合适的身份验证方法和受支持的接口来设置身份验证:

    环境 接口 身份验证方法
    Google Cloud
    • REST
    • 客户端库
    使用关联的服务帐号
    本地或其他云服务提供商 REST 使用 API 密钥工作负载身份联合

    如果您想使用 API 密钥,建议您通过应用 API 密钥限制来保护 API 密钥。

    客户端库

    使用以下资源:

后续步骤