Getting Started

Copia un prompt de configuración con los pasos de instalación y la guía de markdown completa para este plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-recaptcha`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/recaptcha/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Instalar

Puedes utilizar nuestra configuración asistida por IA para instalar el plugin. Agrega las Capgo habilidades a tu herramienta de IA utilizando el siguiente comando:

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

Luego utilice la siguiente solicitud:

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

Si prefiere la configuración manual, instale el complemento ejecutando los siguientes comandos y siguiendo las instrucciones específicas de la plataforma a continuación:

npm install @capgo/capacitor-recaptcha
npx cap sync

Configurar Claves de Sitio

Crear claves de plataforma en Google Cloud reCAPTCHA, luego agregueles 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, iosSiteKey, y webSiteKey Sobreescribir la configuración compartida siteKey. 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() de manera automática cuando el cliente no está listo, por lo que un paso de carga explícita es opcional.

Estándar de Web reCAPTCHA v3

Establecer enterprise: false 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',
});

En Android e iOS, el camino nativo de Google SDK es solo para empresas. Pasar 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. Prefiera los nombres de config Capacitor para nuevos code.

Sigue adelante desde Getting Started

Si estás utilizando Getting Started para planificar la autenticación y los flujos de cuenta, conecta 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 de dos factores para el detalle de implementación en Autenticación de dos factores.