Getting Started

GitHub

Kopieren Sie einen Setup-Vorschlag mit den Installationsanweisungen und der vollständigen Markdown-Anleitung für diesen 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.

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie den Capgo-Fähigkeiten Ihrer KI-Zubehörstücke mit 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 eine manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die Plattform-spezifischen Anweisungen unten befolgen:

bun add @capgo/capacitor-recaptcha
bunx cap sync

Site-Schlüssel konfigurieren

Erstellen Sie in Google Cloud reCAPTCHA Plattform-Schlüssel und fügen Sie sie dann hinzu zu 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 gemeinsam genutzte siteKeySie können auch einen 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() aufrufen load() automatisch, wenn der Client nicht bereit ist, daher ist ein expliziter Vorkompilierungsschritt optional.

Web-Standard reCAPTCHA v3

Zu laden 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',
});

Auf Android und iOS ist Googles native mobile SDK-Pfad nur für Enterprise/mobile verfügbar. Bei Weitergabe enterprise: false auf nativen Plattformen wird es abgelehnt, daher wird kein Standard-Web-v3-Schlüssel versehentlich verwendet.

Migrationshinweise

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

Fortsetzen Sie mit Getting Started

Wenn Sie Getting Started verwenden Getting Started für die Planung der Authentifizierung und Kontenflüsse, verbinden Sie es mit Verwendung von @capgo/capacitor-recaptcha für die native Fähigkeit in Verwendung von @capgo/capacitor-recaptcha, für @capgo/capacitor-social-login für die Implementierungsdetails in @capgo/capacitor-social-login, für @capgo/capacitor-passkey für die Implementierungsdetails in @capgo/capacitor-passkey, für @capgo/capacitor-native-biometric für die Implementierungsdetails in @capgo/capacitor-native-biometric und Zwei-Faktor-Authentifizierung für die Implementierungsdetails in Zwei-Faktor-Authentifizierung.