Inicio rápido

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

Estándar Web reCAPTCHA v3

Establecer 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 se rechaza en plataformas nativas, por lo que no se usa accidentalmente una clave Web estándar v3.

Notas de migración

El plugin acepta las antiguas opciones de Cordova con alias sitekeyAndroid y sitekeyWeb en opciones de llamada y Capacitor config. También acepta sitekeyIos y sitekeyIOS como alias de migración de iOS. Prefiere los nombres de Capacitor config para nuevos code.

Sigue adelante desde Getting Started

If you are using Getting Started para planificar la autenticación y los flujos de cuenta, conecte con Usando @capgo/capacitor-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 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 la autenticación de dos factores.