Inicio

Configuración

Puede utilizar nuestra configuración asistida por IA para instalar el plugin. 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 plugin ejecutando los siguientes comandos y siga 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() 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() se llama automáticamente 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 de reCAPTCHA v3 de Google estándar de la web.

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

En Android e iOS, el camino nativo de Google de 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 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 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 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-autenticación-nativa-biográfica para el detalle de implementación en @capgo/capacitor-autenticación-nativa-biográfica, y Autenticación en dos factores para el detalle de implementación en Autenticación en dos factores.