Démarrage

Installer

npm install @capgo/capacitor-recaptcha
npx cap sync

Configurer les clés de site

Créer des clés de plateforme dans Google Cloud reCAPTCHA, puis les ajouter à 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 ou load() lorsque la clé dépend de votre environnement. execute() Générer un Jeton

Sous-titre « 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() de manière automatique lorsque le client n'est pas prêt, donc une étape de préchargement explicite est facultative. load() Standard Web reCAPTCHA v3

override the shared

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 configuration. 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 En utilisant @capgo/capacitor-recaptcha pour la capacité native dans En utilisant @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-authentification biométrique native pour les détails d'implémentation dans @capgo/capacitor-authentification biométrique native, et Authentification à deux facteurs pour les détails d'implémentation dans Authentification à deux facteurs.