Démarrage

Installer

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA à 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 au plateforme ci-dessous :

npm install @capgo/capacitor-recaptcha
npx cap sync

Configurer les clés du 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, iosSiteKey, et webSiteKey remplacez la clé partagée siteKey. Vous pouvez également passer directement siteKey directement à load() ou execute() lorsque la clé dépend de votre environnement.

Générer Un Jeton

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() appelle load() s'effectue automatiquement lorsque le client n'est pas prêt, donc une étape de préchargement explicite est facultative.

Standard Web reCAPTCHA v3

Sélectionner enterprise: false pour charger le script standard 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 est rejetée sur les plateformes natives, ce qui signifie que la clé standard Web v3 n'est pas utilisée par accident.

Notes de migration

Le plugin accepte les anciens alias de l'option Cordova sitekeyAndroid et sitekeyWeb dans les options d'appel et la Capacitor config. Il accepte également sitekeyIos et sitekeyIOS comme des alias de migration vers iOS. Préférez les noms de configuration Capacitor pour les nouveaux code.

Continuez de l'étape de démarrage

Si vous utilisez Démarrage pour planifier l'authentification et les flux de compte, connectez-le avec Utilisation de @capgo/capacitor-recaptcha pour la capacité native dans Utilisation de @capgo/capacitor-recaptcha, @capgo/capacitor-social-login pour le détail d'implémentation dans @capgo/capacitor-social-login, @capgo/capacitor-passkey pour le détail d'implémentation dans @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.