Getting Started

Copie 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

Puede utilizar nuestra configuración asistida por IA para instalar el complemento. Agregue las Capgo habilidades a su 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

Cree 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, iosSiteKeyy webSiteKey sobreescribir la compartida siteKey. También puedes pasar un siteKey directamente a load() o execute() ¿O qué alternativas tenemos?

¿Cuándo la clave depende de tu entorno?

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() Copiar a portapapeles load() llama

se llama automáticamente cuando el cliente no está listo, por lo que un paso de carga explícita es opcional.

Configura enterprise: false para cargar el script de reCAPTCHA v3 estándar 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 para SDK solo está disponible en Enterprise/mobile. Pasar enterprise: false en plataformas nativas se rechaza, por lo que no se utiliza accidentalmente una clave de reCAPTCHA 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 config. También acepta sitekeyIos y sitekeyIOS como alias de migración de iOS. Prefiere los nombres de configuración Capacitor para nuevos code.

Sigue adelante desde Getting Started

Si estás utilizando Inicio 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-nativo-biometrico para el detalle de implementación en @capgo/capacitor-nativo-biometrico, y Autenticación de dos factores para el detalle de implementación en Autenticación de dos factores.