Getting Started

Copy prompt pengaturan dengan langkah instalasi dan panduan markdown lengkap untuk plugin ini.

        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.

Instal

npm install @capgo/capacitor-recaptcha
npx cap sync

Konfigurasi Kunci Situs

Buat kunci platform di Google Cloud reCAPTCHA, kemudian tambahkan ke 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, iosSiteKeydan webSiteKey menggantikan yang bersama siteKeyAnda juga dapat melewati sebuah siteKey langsung ke load() atau execute() ketika kunci bergantung pada lingkungan Anda.

Menghasilkan 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() menghasilkan panggilan load() otomatis ketika klien tidak siap, sehingga langkah pra-muat secara eksplisit tidak wajib.

Standar Web reCAPTCHA v3

Atur untuk memuat skrip Web reCAPTCHA v3 standar Google. enterprise: false Salin ke clipboard

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 Catatan Migrasi

Bagian berjudul “Catatan Migrasi”

dan sitekeyAndroid dalam panggilan opsi dan __CAPGO_KEEP_0__ konfigurasi. Ini juga menerima sitekeyWeb in call options and Capacitor config. It also accepts sitekeyIos sebagai nama alias migrasi iOS. Gunakan nama __CAPGO_KEEP_0__ konfigurasi untuk __CAPGO_KEEP_1__ baru. sitekeyIOS as iOS migration aliases. Prefer the Capacitor config names for new code.

Terus lanjutkan dari Getting Started

Jika Anda menggunakan Getting Started untuk merencanakan autentikasi dan alur akun, hubungkannya dengan Menggunakan @capgo/capacitor-recaptcha untuk kemampuan asli di Menggunakan @capgo/capacitor-recaptcha, @capgo/capacitor-social-login untuk detail implementasi di @capgo/capacitor-social-login, @capgo/capacitor-passkey untuk detail implementasi di @capgo/capacitor-passkey, @capgo/capacitor-native-biometric untuk detail implementasi di @capgo/capacitor-native-biometric, dan Autentikasi Dua Faktor untuk detail implementasi di Autentikasi Dua Faktor.