@capgo/capacitor-recaptcha

中文文档
8.1.18发布于 2026/10/15MPL-2.0TypeScriptESM + CJS零依赖构建来源已验证近 30 天下载 4.2万

生成 reCAPTCHA 和 reCAPTCHA 企业代号的电容插件.

中文使用文档
文档目录17 节
  1. *免费开始*
  2. 主要特点
  3. 兼容性
  4. 安装
  5. 配置
  6. 使用量
  7. 平台设置
  8. 机器人
  9. iOS系统
  10. 网页
  11. 页:1
  12. 示例应用
  13. API 密码
  14. 装入(...)
  15. 执行(...)
  16. 获取 PluginVersion ()
  17. 接口

@ capgo/ 电容- recaptcha

在您的 Capacitor app 中保护签名、登录和付款, 网络、 Android 和 iOS 上的 reCAPTCHA 令牌, 并由您的后端验证 .

Capgo - Build Capacitor apps with AI, ship updates instantly

队长:在几分钟内将修正推给您的 Capacitor 用户,在没有Mac的情况下构建已签名的iOS和Android apps,并在一击中回滚.

*免费开始*

14天无限自由审判. 不需要信用卡

🤖 建筑与AI编码代理? 安装 Capgo 技能 所以克劳德代码,代码,光标,副驾驶,或双子座CLI知道如何安装和使用 @capgo/capacitor-recaptcha 在您的电容应用程序中: npx skills add Cap-go/capgo-skills。然后问你的经纪人: 添加@capgo/capor-recaptcha到我的Capacitor应用上,并把它接上。" 代理设置指南 • 妇女 主机磁共振

@capgo/capacitor-recaptcha for Capacitor apps

主要特点

  • 装入数字 : load() 初始化并缓存 reCAPTCHA 客户端.
  • 执行数字 : execute() 返回动作的符号,准备后端验证.
  • 移动: reCAPTCHA Entertainment SDKs on Android and iOS. 互联网档案馆的存檔,存档日期2013-12-20.
  • 网页: reCAPTCHA v3 与 (中文(简体) ) api.js,或与 enterprise.js。 。 。 .
  • 每个平台键数字 : androidSiteKey, (中文(简体) ), iosSiteKey 财务报告和审定财务报表 webSiteKey 赢得共享 siteKey 设置在同一级别.
  • 平台: iOS,Android和Web. 互联网档案馆的存檔,存档日期2013-12-02.

在Web,Android,和iOS上生成 reCAPTCHA 令牌的电容插件.

它支持:

  • 网络 reCAPTCHA v3 与 api.js
  • 使用 Web reCAPTCHA 企业 enterprise.js
  • Android和iOS reCAPTCHA 企业/移动式SDKs

在登录,注册,取出,密码重置等敏感动作前使用,或者在易被滥用的形式提交之前使用. 信使必须发送到您的后端 并通过创建 reCAPTCHA 评估来核实.

兼容性

插件版本电容兼容性维护
v八.。 。 。 .v八.。 。 。 .对
v.。 。 。 .v.。 。 。 .应要求
v6 (英语).。 。 。 .v6 (英语).。 。 。 .没有
页:1.。 。 。 .页:1.。 。 。 .没有

此插件的主要版本沿用了Capacitor的主要版本.

安装

您可以使用我们的 AI 辅助设置安装插件 。 使用以下命令将 Capgo 技能添加到您的 AI 工具 :

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

然后使用下列提示:

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

如果您更喜欢手动设置,请通过运行以下命令来安装插件,并遵循下面的平台特定指令:

npm install @capgo/capacitor-recaptcha
npx cap sync

配置

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;

也可以通过 siteKey 直接转到 load() 或者说 execute() 当密钥是针对环境的.

使用量

import { Recaptcha } from '@capgo/capacitor-recaptcha';

await Recaptcha.load();

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

常规Web reCAPTCHA v3:

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

平台设置

机器人

在 Google Cloud reCAPTCHA 中创建一个Android 移动应用程序密钥并将其用作 androidSiteKey 或者说 siteKey。 。 。 .

Android使用Google的移动 reCAPTCHA SDK. 常规的,非企业的 reCAPTCHA v3 只能在这个插件的Web上提供 ; enterprise: false 在Android上被拒绝.

插件取决于 :

com.google.android.recaptcha:recaptcha:18.8.0

Google的Android reCAPTCHA SDK要求消费应用中的核心库去蛋白. 插件可以在 npx cap sync android 并添加:

com.android.tools:desugar_jdk_libs:2.1.5

您可以在您的应用程序 Gradle 配置中覆盖版本 recaptchaVersion。 。 。 . 您可以通过 desugarJdkLibsVersion。 。 。 .

iOS系统

在 Google Cloud reCAPTCHA 中创建一个 iOS 移动应用程序密钥并将其用作 iosSiteKey 或者说 siteKey。 。 。 .

iOS 使用谷歌软件 RecaptchaEnterprise 移动 SDK. 常规的,非企业的 reCAPTCHA v3 只能在这个插件的Web上提供 ; enterprise: false 在 iOS 上被拒绝.

插件同时传送 Swift 套件管理器和 CocoaPods 元数据并依赖于 Google RecaptchaEnterprise iOS SDK. (英语).

网页

使用网站密钥 。 设定 enterprise: true 企业或 enterprise: false 用于常规 reCAPTCHA v3.

页:1

  • 托肯是单用,应当在受保护后端请求前立即生成.
  • 通过创建 reCAPTCHA 评估来验证你后端的每个符号.
  • 科多瓦旧地 sitekeyAndroid 财务报告和审定财务报表 sitekeyWeb 选项名在调用选项和 Capacitor 配置中被接受为迁移别名.
  • sitekeyIos 财务报告和审定财务报表 sitekeyIOS 在调用选项和Capacitor配置中被接受为iOS迁移别名.

示例应用

这个 example-app/ 本地插件的文件夹链接 file:..。 。 。 .

cd example-app
npm install
npm run start

API 密码

reCAPTCHA 插件 API.

装入(...)

load(options?: LoadOptions | undefined) => Promise<LoadResult>

装入并缓存当前平台的 reCAPTCHA 客户端.

execute() 在需要时自动加载客户端,所以调用这种方法是可选的.

参数类型
optionsLoadOptions

回返情况: Promise<LoadResult>

自: 8.0.0 (单位:千美元)


执行(...)

execute(options: ExecuteOptions) => Promise<ExecuteResult>

执行reCAPTCHA的动作并返回后端评估的符号.

参数类型
optionsExecuteOptions

回返情况: Promise<ExecuteResult>

自: 8.0.0 (单位:千美元)


获取 PluginVersion ()

getPluginVersion() => Promise<PluginVersionResult>

返回平台执行版本标记 .

回返情况: Promise<PluginVersionResult>

自: 8.0.0 (单位:千美元)


接口

装入结果

客户端装入后返回结果 .

Prop类型说明自兹
loadedboolean平台客户端是否准备好 .8.0.0 (单位:千美元)
siteKeystring用于装入客户端的站点密钥 .8.0.0 (单位:千美元)
enterpriseboolean是否请求企业模式 .8.0.0 (单位:千美元)
platform'web' | 'ios' | 'android'装入客户端的平台 .8.0.0 (单位:千美元)

装入选项

用于装入 reCAPTCHA 客户端的选项 .

Prop类型说明默认自兹
siteKeystring此调用所用的站点密钥 。 如果省略,插件会从 Capacitor 配置读取平台特定密钥.8.0.0 (单位:千美元)
androidSiteKeystringAndroid站点密钥.8.0.0 (单位:千美元)
iosSiteKeystringiOS站点密钥.8.0.0 (单位:千美元)
webSiteKeystring网站密钥.8.0.0 (单位:千美元)
sitekeyAndroidstring科尔多瓦遗产 Android站点密钥别名.8.1.1 国家
sitekeyIosstring遗产式iOS站点关键别名.8.1.1 国家
sitekeyIOSstring遗产式iOS站点关键别名.8.1.1 国家
sitekeyWebstring科尔多瓦遗产 网站密钥别名.8.1.1 国家
enterpriseboolean网络模式开关. 网络使用 enterprise.js 当真实和正常的 reCAPTCHA v3 api.js 当虚假。 Android和iOS使用Google的移动 reCAPTCHA SDK,它只是企业号/移动. 通过 enterprise: false 在Android或iOS上被拒绝.true8.0.0 (单位:千美元)
languagestringWeb reCAPTCHA脚本的可选语言代码.8.0.0 (单位:千美元)

执行结果

执行保护动作后返回结果 .

Prop类型说明自兹
tokenstring由reCAPTCHA生成的托肯. 把这个发送给您的后端, 并在那里创建评估 .8.0.0 (单位:千美元)
actionstring用于生成符号的动作名 .8.0.0 (单位:千美元)
siteKeystring用于生成令牌的站点密钥 .8.0.0 (单位:千美元)
enterpriseboolean是否请求企业模式 .8.0.0 (单位:千美元)
platform'web' | 'ios' | 'android'生成符号的平台.8.0.0 (单位:千美元)

执行选项

用于执行被保护动作的选项 .

Prop类型说明自兹
actionstring动作名来保护. 使用有意义的名称, 如 login, (中文(简体) ), signup, (中文(简体) ), checkout,或 password_reset。 。 。 .8.0.0 (单位:千美元)
timeoutnumber可选本土处决超时数以毫秒计. 提供Android和iOS时执行至少5000ms的超时. 此值在 Web 被忽略 .8.0.0 (单位:千美元)

插件变压器

插件版本有效载荷 .

Prop类型说明自兹
versionstring版本标识符由平台执行返回.8.0.0 (单位:千美元)

版本与发布记录

@capgo/capacitor-recaptcha 共发布 19 个版本,首次发布于 2026/05/12;过去 12 个月发布了 19 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
8.1.18latest2026/10/1525 天前
8.1.172026/10/1327 天前
8.1.162026/10/1030 天前
8.1.152026/10/091 个月前
8.1.142026/10/081 个月前
8.1.132026/10/081 个月前

关于 @capgo/capacitor-recaptcha 的常见问题

@capgo/capacitor-recaptcha 是什么?

生成 reCAPTCHA 和 reCAPTCHA 企业代号的电容插件.

如何安装 @capgo/capacitor-recaptcha?

在项目目录运行 npm install @capgo/capacitor-recaptcha,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@capacitor/core(>=8.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@capgo/capacitor-recaptcha 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@capgo/capacitor-recaptcha 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@capgo/capacitor-recaptcha 可以商用吗?

@capgo/capacitor-recaptcha 使用 MPL-2.0 许可。弱 Copyleft:可以商用,也可以和闭源代码一起使用;但如果分发时修改了 MPL 授权的文件,这些文件的修改需以 MPL 开源。以上为概括,不构成法律意见,请以许可原文为准。

@capgo/capacitor-recaptcha 的下载量有多少?

根据 npm 官方下载统计,@capgo/capacitor-recaptcha 在 2026/10/09 – 2026/11/07 这 30 天内被下载 41,729 次,日均约 1,391 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@capgo/capacitor-recaptcha 还在维护吗?

最新版本 8.1.18 发布于 2026/10/15(25 天前);至今共发布 19 个版本,其中过去 12 个月发布了 19 个;首次发布于 2026/05/12。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。