Getting Started

インストール

AIアシストセットアップを使用してプラグインをインストールできます。AIツールにCapgoスキルを追加するには、以下のコマンドを実行してください。

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

次に、以下のプロンプトを使用してください:

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

Manual Setup を使用する場合は、以下のコマンドを実行してプラットフォーム固有の指示に従ってください:

npm install @capgo/capacitor-recaptcha
npx cap sync

サイト キーを設定

Google Cloud reCAPTCHA でプラットフォーム キーを作成し、次にそれらを追加してください: 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、 webSiteKey 共有設定を上書き siteKey. または環境に依存するキーに応じて siteKey 直接を load() または execute() 環境に依存するキーに応じて

トークンを生成

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() 呼び出し load() 自動的にクライアントが準備されていない場合に呼び出され、明示的なプレロードステップは省略可能です。

Web Standard reCAPTCHA v3

設定 enterprise: false Googleの標準Web reCAPTCHA v3スクリプトをロードする

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

AndroidおよびiOSでは、GoogleのネイティブモバイルSDKパスはエンタープライズ/モバイルのみです。 enterprise: false nativeプラットフォームでは、標準Web v3キーが誤って使用されないように、__CAPGO_KEEP_0__キーが渡されます。

移行ノート

プラグインは古いCordovaオプションのエイリアスを認識します sitekeyAndroid 古いCordovaオプションのエイリアスと__CAPGO_KEEP_0__設定を認識します。 sitekeyWeb 古いCordovaオプションのエイリアスとCapacitor設定を認識します。 sitekeyIos 新しい__CAPGO_KEEP_1__のために__CAPGO_KEEP_0__設定名を使用することをお勧めします。 sitekeyIOS as iOS migration aliases. Prefer the Capacitor config names for new code.

targetLanguage

あなたは「を使用しています Getting Started 認証とアカウントフローの計画に使用する場合、を接続してください native capabilityの「@capgo/capacitor-recaptcha」 native capabilityの「@capgo/capacitor-recaptcha」の実装詳細 「@capgo/capacitor-social-login」 「@capgo/capacitor-social-login」の実装詳細 「@capgo/capacitor-passkey」 「@capgo/capacitor-passkey」の実装詳細 「@capgo/capacitor-native-biometric」 「@capgo/capacitor-native-biometric」の実装詳細 2要素認証 2要素認証の実装詳細について