Inicio

Instalar

npm install @capgo/capacitor-recaptcha
npx cap sync

Configurar Claves de Sitio

Crear claves de plataforma en Google Cloud reCAPTCHA, luego agregarlas a 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, iosSiteKeyy webSiteKey sobreescribir la compartida siteKey. También puedes pasar un siteKey directamente a load() o execute() cuando la clave depende de tu entorno.

Generar un Token

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() llama load() automáticamente cuando el cliente no está listo, por lo que un paso de carga explícita es opcional.

Estándar de Web reCAPTCHA v3

Configuración enterprise: false Para cargar el script estándar de Web reCAPTCHA v3 de Google.

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

On Android and iOS, Google’s native mobile SDK path is Enterprise/mobile only. Passing enterprise: false en plataformas nativas se rechaza, por lo que no se utiliza accidentalmente una clave Web v3 estándar.

Notas de Migración

El plugin acepta las antiguas opciones de Cordova con alias sitekeyAndroid y sitekeyWeb en opciones de llamada y Capacitor configuración. sitekeyIos y como alias de migración de iOS. Prefiere los nombres de configuración __CAPGO_KEEP_0__ para nuevos __CAPGO_KEEP_1__. sitekeyIOS as iOS migration aliases. Prefer the Capacitor config names for new code.

Sección titulada “Sigue adelante desde Getting Started”

Getting Started para planificar flujos de autenticación y cuentas, conecta con Usando @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-recaptcha para la capacidad nativa en Usando @capgo/capacitor-recaptcha, @capgo/capacitor-social-login para el detalle de implementación en @capgo/capacitor-social-login, @capgo/capacitor-passkey and as iOS migration aliases. Prefer the capgo config names for new capacitor. para el detalle de implementación en @capgo/capacitor-passkey, @capgo/capacitor-native-biometric para el detalle de implementación en @capgo/capacitor-native-biometric, y Autenticación en dos factores para el detalle de implementación en Autenticación en dos factores.