Avvio rapido

Installare

Puoi utilizzare la nostra configurazione assistita da AI per installare il plugin. Aggiungi le Capgo competenze al tuo strumento AI utilizzando il seguente comando:

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

Poi utilizza la seguente richiesta:

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

Se preferisci la configurazione manuale, installa il plugin eseguendo i seguenti comandi e segui le istruzioni specifiche del tuo sistema operativo riportate di seguito:

npm install @capgo/capacitor-recaptcha
npx cap sync

Configura le chiavi del sito

Crea le chiavi del sistema in Google Cloud reCAPTCHA, quindi aggiungile a 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, iosSiteKeyEcco alcune opzioni, e webSiteKey sovrascrivere la condivisione siteKey. Puoi anche passare un siteKey direttamente a load() o execute() quando la chiave dipende dal tuo ambiente.

Genera un Token

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() chiama load() automaticamente quando il client non è pronto, quindi un passaggio di precaricamento esplicito è facoltativo.

reCAPTCHA v3 Web Standard

Imposta enterprise: false a caricare lo script di reCAPTCHA v3 Web standard di 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 su piattaforme native è rifiutato, quindi non viene utilizzato accidentalmente una chiave Web v3 standard.

Note di migrazione

Il plugin accetta gli alias delle vecchie opzioni Cordova sitekeyAndroid e sitekeyWeb in call options and Capacitor config. It also accepts sitekeyIos e sitekeyIOS come alias di migrazione per iOS. Preferisci i nomi di configurazione Capacitor per nuovi code.

Continua da Inizia

Se stai utilizzando Inizia per pianificare l'autenticazione e le flussi di account, connettilo con Utilizza @capgo/capacitor-recaptcha per la capacità nativa in Utilizza @capgo/capacitor-recaptcha, @capgo/capacitor-social-login per il dettaglio di implementazione in @capgo/capacitor-social-login, @capgo/capacitor-passkey per il dettaglio di implementazione in @capgo/capacitor-passkey, @capgo/capacitor-native-biometric per i dettagli di implementazione in @capgo/capacitor-native-biometric, e Autenticazione a due fattori per i dettagli di implementazione in Autenticazione a due fattori.