开始

安装

您可以使用我们的 AI 助手设置来安装插件。使用以下命令将 Capgo 技能添加到您的 AI 工具中：

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下提示:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-recaptcha` plugin in my project.

如果您更喜欢手动设置，请运行以下命令安装插件，并按照以下平台特定的说明进行操作:

npm install @capgo/capacitor-recaptcha
npx cap sync

配置站点密钥

在Google Cloud reCAPTCHA中创建平台密钥，然后将其添加到 capacitor.config.ts.

import type { CapacitorConfig } from '@capacitor/cli';
import '@capgo/capacitor-recaptcha';

const config: CapacitorConfig = {
  appId: 'com.example.app',
  appName: 'Example',
  webDir: 'dist',
  plugins: {
    Recaptcha: {
      androidSiteKey: 'ANDROID_SITE_KEY',
      iosSiteKey: 'IOS_SITE_KEY',
      webSiteKey: 'WEB_SITE_KEY',
      enterprise: true,
    },
  },
};

export default config;

androidSiteKey, iosSiteKey, webSiteKey 覆盖共享 siteKey. 您也可以直接传递一个 siteKey 直接传递到 load() 或 execute() 当密钥取决于您的环境时

生成令牌

import { Recaptcha } from '@capgo/capacitor-recaptcha';

const { token } = await Recaptcha.execute({
  action: 'login',
});

await fetch('/api/recaptcha-assessment', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({ token, action: 'login' }),
});

execute() 自动调用 load() 当客户端未准备好时，显式预加载步骤是可选的。

Web Standard reCAPTCHA v3

设置 enterprise: false 加载 Google 的标准 Web reCAPTCHA v3 脚本。

const { token } = await Recaptcha.execute({
  siteKey: 'WEB_V3_SITE_KEY',
  enterprise: false,
  action: 'signup',
});

在 Android 和 iOS 上，Google 的本机移动 SDK 路径仅限企业/移动。传递 enterprise: false 在本机平台上传递会被拒绝，因此不会意外使用标准 Web v3 密钥。

迁移说明

插件接受旧 Cordova 选项别名 sitekeyAndroid 和 sitekeyWeb 在调用选项和 Capacitor 配置中接受 sitekeyIos 和 sitekeyIOS 作为 iOS 迁移别名。尽量使用 Capacitor 配置名称来新建 code。

从 Getting Started 继续

如果您正在使用 Getting Started 来规划身份验证和帐户流程，连接它与 使用 @capgo/capacitor-recaptcha 为native能力在使用 @capgo/capacitor-recaptcha 中 @capgo/capacitor-social-login 为实现细节在 @capgo/capacitor-social-login 中 @capgo/capacitor-passkey 为实现细节在 @capgo/capacitor-passkey 中 @capgo/capacitor-native-biometric 为实现细节在 @capgo/capacitor-native-biometric 中 双因素身份验证 为双因素身份验证的实现细节.