Getting Started

Salin 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

Anda dapat menggunakan Pengaturan AI Bantu untuk menginstal plugin. Tambahkan Capgo kemampuan ke alat AI Anda menggunakan perintah berikut:

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

Lalu gunakan prompt berikut:

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

Jika Anda lebih suka Manual Setup, instal plugin dengan menjalankan perintah-perintah berikut dan ikuti instruksi spesifik platform di bawah ini:

npm install @capgo/capacitor-recaptcha
npx cap sync

Konfigurasi Kunci Situs

Buat kunci platform di Google Cloud reCAPTCHA, lalu 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, iosSiteKey, dan webSiteKey atasi kunci bersama siteKeyAnda juga dapat memasukkan nilai langsung ke siteKey atau load() ketika kunci bergantung pada lingkungan. execute() Menghasilkan Token

Bagian berjudul “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() otomatis ketika klien tidak siap, sehingga langkah pra-muat ulang eksplisit tidak wajib. load() Standar Web reCAPTCHA v3

Bagian berjudul “Standar Web reCAPTCHA v3”

__CAPGO_KEEP_0__ enterprise: false untuk memuat skrip Web reCAPTCHA v3 standar Google.

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

Pada Android dan iOS, jalur mobile native Google SDK hanya tersedia untuk Enterprise saja. Penggunaan enterprise: false di platform native ditolak sehingga kunci Web v3 tidak digunakan secara tidak sengaja.

Catatan Migrasi

Plugin ini menerima nama-nama alias opsi lama Cordova sitekeyAndroid dan sitekeyWeb dalam panggilan opsi dan Capacitor konfigurasi. Ini juga menerima sitekeyIos dan sitekeyIOS sebagai nama alias migrasi iOS. Gunakan nama-nama konfigurasi Capacitor untuk code baru.

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.