Getting Started

Installieren

Sie können unser AI-gestütztes Setup verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten zu Ihrem AI-Tool hinzu, indem Sie folgenden Befehl ausführen:

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

Verwenden Sie dann die folgende Anweisung:

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 die plattform-spezifischen Anweisungen unten befolgen:

npm install @capgo/capacitor-recaptcha
npx cap sync

Site-Schlüssel konfigurieren

Erstellen Sie in Google Cloud reCAPTCHA Plattform-Schlüssel, fügen Sie sie dann hinzu 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 webSiteKey überschreiben Sie die gemeinsamen siteKey. Sie können auch einen direkten Token übergeben. siteKey direkt an load() oder execute() wenn die Schlüssel von Ihrer Umgebung abhängen.

Token generieren

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() wird load() automatisch aufgerufen, wenn der Client nicht bereit ist, daher ist ein expliziter Vorkompilierungsschritt optional.

Web-Standard reCAPTCHA v3

Setzen 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 Enterprise/mobile verfügbar. Die Übertragung enterprise: false Da auf nativen Plattformen die Übertragung abgelehnt wird, wird ein Standard-Web v3-Schlüssel versehentlich nicht verwendet.

Migrationshinweise

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

Weitermachen von Getting Started

Wenn Sie "Anfangen" verwenden Anfangen um die Authentifizierung und die Kontofluss-Planung zu verbinden Verwenden Sie @capgo/capacitor-recaptcha für die native Fähigkeit in Verwenden Sie @capgo/capacitor-recaptcha Verwenden Sie @capgo/capacitor-social-login für die Implementierungsdetail in @capgo/capacitor-social-login Verwenden Sie @capgo/capacitor-passkey für die Implementierungsdetail in @capgo/capacitor-passkey Verwenden Sie @capgo/capacitor-native-biometric für die Implementierungsdetail in @capgo/capacitor-native-biometric Zwei-Faktor-Authentifizierung für die Implementierungsdetail in Zwei-Faktor-Authentifizierung.