Anleitung zum Starten

GitHub

Eine Einrichtungsanweisung mit den Installationsanweisungen und der vollständigen Markdown-Dokumentation für diesen Plugin kopieren.

        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

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

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

Verwenden Sie dann 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 die untenstehenden plattform-spezifischen Anweisungen befolgen:

npm install @capgo/capacitor-recaptcha
npx cap sync

Seiten-Schlüssel konfigurieren

Erstellen Sie in Google Cloud reCAPTCHA Plattform-Schlüssel 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 webSiteKey überschreiben Sie die gemeinsam genutzte siteKey. Sie 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 noch nicht bereit ist, sodass ein expliziter Vorkompilierungsschritt optional ist.

Web-Standard reCAPTCHA v3

Setzen enterprise: false Google’s Standard-Web-reCAPTCHA-v3-Skript laden.

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

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

Migrationshinweise

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

Weitermachen von Getting Started

Wenn Sie Getting Started für die Planung der Authentifizierung und Benutzerflüsse verwenden, verbinden Sie es mit Mit @capgo/capacitor-reCAPTCHA für die native Fähigkeit in Mit @capgo/capacitor-reCAPTCHA, @capgo/capacitor-social-Login für die Implementierungsdetails in @capgo/capacitor-social-Login, @capgo/capacitor-Passkey für die Implementierungsdetails in @capgo/capacitor-Passkey, @capgo/capacitor-native-biometrisch für die Implementierungsdetails in @capgo/capacitor-native-biometrisch, und Zwei-Faktor-Authentifizierung für die Implementierungsdetails in Zwei-Faktor-Authentifizierung.