Getting Started

Copiez un prompt de configuration avec les étapes d'installation et le guide Markdown complet pour ce plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-recaptcha`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/recaptcha/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

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 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

Définir enterprise: false pour charger le script de reCAPTCHA v3 Web standard 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é de reCAPTCHA v3 standard n'est pas utilisée par erreur.

Notes de migration

Le plugin accepte les anciens alias d'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 native de biométrie pour les détails d'implémentation dans @capgo/capacitor-authentification native de biométrie, et L'authentification à deux facteurs pour les détails d'implémentation dans L'authentification à deux facteurs.