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 à 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, iosSiteKey, et webSiteKey remplacez les clés partagées par siteKey. Vous pouvez également passer directement à siteKey ou load() lorsque la clé dépend de votre environnement. execute() Générer un jeton

Section intitulée “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() automatiquement lorsque le client n'est pas prêt, donc une étape de chargement explicite est facultative. load() Norme Web reCAPTCHA v3

Section intitulée “Norme Web reCAPTCHA v3”

__CAPGO_KEEP_0__ enterprise: false To charger l'écriture 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 les options d'appel et la configuration Capacitor. Il accepte également sitekeyIos et sitekeyIOS les alias de migration iOS comme alias. Préférez les noms de configuration Capacitor pour les nouveaux code.

Continuez de l'étape de démarrage

Si vous utilisez Getting Started pour planifier l'authentification et les flux de compte, connectez-le avec Utilisez @capgo/capacitor-recaptcha pour la capacité native dans Utilisez @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-biometric pour le détail d'implémentation dans @capgo/capacitor-native-biometric, et Deux facteurs d'authentification pour le détail d'implémentation dans Deux facteurs d'authentification.