Démarrage

Installer

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil AI à l'aide de la commande suivante :

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

Ensuite, utilisez la prompt suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

npm install @capgo/capacitor-recaptcha
npx cap sync

Configurer les clés de site

Créez des clés de plateforme dans Google Cloud reCAPTCHA, puis ajoutez-les à 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, iosSiteKeyet webSiteKey remplacez la valeur partagée siteKey. Vous pouvez également passer un siteKey directement à load() ou execute() ou

lorsque la clé dépend de votre environnement.

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() Copier dans le presse-papier load() appelle

se déclenche automatiquement lorsque le client n'est pas prêt, donc une étape de préchargement explicite est facultative : Web Standard reCAPTCHA v3

Configurer enterprise: false pour charger le script Web standard 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 est rejetée sur les plateformes natives, ce qui empêche l'utilisation accidentelle d'une clé Web v3 standard.

Notes de migration

Le plugin accepte les anciens alias d'options de Cordova sitekeyAndroid et sitekeyWeb in call options and Capacitor config. It also accepts sitekeyIos et sitekeyIOS en tant que pseudonymes de migration vers iOS. Préférez les noms de configuration Capacitor pour les nouveaux code.

Continuez de la section Démarrage rapide

Si vous utilisez Démarrage rapide pour planifier l'authentification et les flux de compte, connectez-l’avec En utilisant @capgo/capacitor-recaptcha pour la capacité native en utilisant @capgo/capacitor-recaptcha, @capgo/capacitor-social-login pour le détail d'implémentation en @capgo/capacitor-social-login, @capgo/capacitor-passkey pour le détail d'implémentation en @capgo/capacitor-passkey, @capgo/capacitor-native-biometrique pour les détails d'implémentation dans @capgo/capacitor-native-biometrique, et Authentification à deux facteurs pour les détails d'implémentation dans Authentification à deux facteurs.