Einstieg

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten Ihrem AI-Tool mithilfe der folgenden Befehl hinzu:

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

Verwenden Sie dann die folgende Anfrage:

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

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und folgen Sie den unten angegebenen Plattform-spezifischen Anweisungen:

npm install @capgo/capacitor-recaptcha
npx cap sync

Konfigurieren Sie die Site Keys

Erstellen Sie Plattform-Schlüssel in Google Cloud reCAPTCHA und fügen Sie sie dann hinzu an 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, iosSiteKeyund, und webSiteKey die gemeinsame überschreiben siteKey. Sie können auch einen siteKey direkt an load() oder execute() oder

als die Schlüssel von Ihrem Umfeld abhängen.

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() Zur Zwischenablage kopieren load() aufrufen

automatisch, wenn der Client nicht bereit ist, sodass ein expliziter Vorkompilierungsschritt optional ist.

Einrichten enterprise: false um Googles Standard-Web-reCAPTCHA v3-Skript zu laden.

const { token } = await Recaptcha.execute({
  siteKey: 'WEB_V3_SITE_KEY',
  enterprise: false,
  action: 'signup',
});

Bei Android und iOS ist Googles native mobile SDK-Pfad nur für Unternehmen verfügbar. Die Übertragung enterprise: false Zurückweisung auf nativen Plattformen wird abgelehnt, daher wird ein Standard-Web-v3-Schlüssel versehentlich nicht verwendet.

Migrationshinweise

Der Plugin akzeptiert die alten Cordova-Option-Alternativen sitekeyAndroid und sitekeyWeb in Aufrufoptionen und Capacitor-Konfiguration. Es akzeptiert auch sitekeyIos und sitekeyIOS als iOS-Migration-Aliase. Wählen Sie die Capacitor-Konfigurationsnamen für neue code.

Fortsetzung von Getting Started

Wenn Sie ‘Getting Started’ verwenden Getting Started um die Authentifizierung und die Kontenflüsse zu planen, verbinden Sie es mit Verwendung von @capgo/capacitor-reCAPTCHA zur Verwendung der native Fähigkeit in Verwendung von @capgo/capacitor-reCAPTCHA zur Verwendung von @capgo/capacitor-social-login zur Implementierungsdetail in @capgo/capacitor-social-login zur Verwendung von @capgo/capacitor-passkey zur Implementierungsdetail in @capgo/capacitor-passkey native-biometrische @capgo/capacitor für die Implementierungsdetails in native-biometrische @capgo/capacitor Zweifaktor-Authentifizierung für die Implementierungsdetails in Zweifaktor-Authentifizierung.