Recaptcha3 field - Revision history

LukeWallin at 14:19, 19 March 2026

2026-03-19T14:19:34Z

LukeWallin at 14:19, 19 March 2026

2026-03-19T14:19:00Z

Drn@ecs.soton.ac.uk at 08:33, 21 July 2024

2024-07-21T08:33:26Z

Drn@ecs.soton.ac.uk at 08:29, 21 July 2024

2024-07-21T08:29:42Z

Drn@ecs.soton.ac.uk: Improved description

2024-07-21T08:29:30Z

Improved description

Drn@ecs.soton.ac.uk: Added Recaptcha3 page

2024-07-20T13:42:22Z

Added Recaptcha3 page

New page

{{fieldtypes}}

== Description ==
Add the following configuration to a file called <code>cfg/cfg.d/recaptcha3.pl</code> in your archive, if it does not already exist.
$c->{recaptcha3}->{private_key} = "CHANGEME";
$c->{recaptcha3}->{public_key} = "CHANGEME";
$c->{recaptcha3}->{min_score} = 0.5;

This field uses the Google "reCAPTCHAv3" service and renders a Captcha (a test that humans can easily pass, but robots shouldn't be able to). You will need to use a Google account to generate a private and public key (also known by Google as a secret key and site key respectively) for the above configuration, this can be done via the '''reCAPTCHA Admin Console''' linked form https://developers.google.com/recaptcha/docs/v3. If you are setting up a Recaptcha3 field for protecting request copy forms, you will need to add the following configuration to a file in your archive's <code>cfg/cfg.d/</code> directory.
$c->add_dataset_field( "request", {
name => "captcha",
replace_core => 1,
type => "recaptcha3",
});

== Inheritance ==
* [[:Category:EPrints_Metadata_Fields|Metadata Field]]
** [[Id field]]
*** [[Recaptcha3 field]]

== Additional Properties ==
As for [[Id field#Additional_Phrases|Id fields]].

== Required Phrases ==
<tt>validate:recaptcha3_mismatch</tt> - Phrase to display if reCAPTCHAv3 submission errored in some way.

== Database ==
Recaptcha3 fields are not stored in the database they are just so reCAPTCHAv3 can be added to certain forms. The result of the reCAPTCHAv3 does not need to be stored.

== API ==
See [[API:EPrints/MetaField/Recaptcha3|API page]].

== Examples ==
Most basic example.
{
name => 'captcha',
type => 'recaptcha3',
}

@@ Line 18: / Line 18: @@
     type => "recaptcha3",
   });
-Also make a copy of <code>lib/workflows/request/default.xml<code> in <code>your/archive/cfg/workflows/request/default.xml</code> and uncomment <component surround="None"><field ref="captcha" /></component>
+Also make a copy of <code>lib/workflows/request/default.xml</code> in <code>your/archive/cfg/workflows/request/default.xml</code> and uncomment <code><component surround="None"><field ref="captcha" /></component></code>
 If you find you are still getting spam from the form to which you have applied a Recaptcha3 field, then try increasing <code>$c->{recaptcha3}->{min_score}</code> to a higher value such as <code>0.7</code>.

@@ Line 18: / Line 18: @@
     type => "recaptcha3",
   });
 If you find you are still getting spam from the form to which you have applied a Recaptcha3 field, then try increasing <code>$c->{recaptcha3}->{min_score}</code> to a higher value such as <code>0.7</code>.

@@ Line 10: / Line 10: @@
   $c->{recaptcha3}->{min_score} = 0.5;
-As this field uses the Google "reCAPTCHAv3" service and renders a Captcha, (a test that humans can easily pass, but robots shouldn't be able to), you will need to use a Google account to generate a private and public key (also known by Google as a secret key and site key respectively) for the above configuration.  This can be done via Google's '''[https://www.google.com/recaptcha/admin/create Site Registration Tool]'''.  By sure to use '''Score based (v3)''' option when registering.
+As this field uses the Google's reCAPTCHAv3 service and renders a Captcha, (a test that humans can easily pass, but robots shouldn't be able to), you will need to use a Google account to generate a private and public key (also known by Google as a '''secret key''' and '''site key''' respectively) for the above configuration.  This can be done via Google's '''[https://www.google.com/recaptcha/admin/create Site Registration Tool]'''.  By sure to use '''Score based (v3)''' option when registering.
 If you are setting up a Recaptcha3 field for protecting request copy forms, you will need to add the following configuration to a file in your archive's <code>cfg/cfg.d/</code> directory.

← Older revision		Revision as of 08:29, 21 July 2024
Line 1:		Line 1:
	{{fieldtypes}}		{{fieldtypes}}
		+

	== Description ==		== Description ==

@@ Line 2: / Line 2: @@
 == Description ==
 Add the following configuration to a file called <code>cfg/cfg.d/recaptcha3.pl</code> in your archive, if it does not already exist.
   $c->{recaptcha3}->{private_key} = "CHANGEME";
@@ Line 7: / Line 9: @@
   $c->{recaptcha3}->{min_score} = 0.5;
-This field uses the Google "reCAPTCHAv3" service and renders a Captcha (a test that humans can easily pass, but robots shouldn't be able to).  You will need to use a Google account to generate a private and public key (also known by Google as a secret key and site key respectively) for the above configuration, this can be done via the '''reCAPTCHA Admin Console''' linked form https://developers.google.com/recaptcha/docs/v3.  If you are setting up a Recaptcha3 field for protecting request copy forms, you will need to add the following configuration to a file in your archive's <code>cfg/cfg.d/</code> directory.
+As this field uses the Google "reCAPTCHAv3" service and renders a Captcha, (a test that humans can easily pass, but robots shouldn't be able to), you will need to use a Google account to generate a private and public key (also known by Google as a secret key and site key respectively) for the above configuration.  This can be done via Google's '''[https://www.google.com/recaptcha/admin/create Site Registration Tool]'''.  By sure to use '''Score based (v3)''' option when registering.
   $c->add_dataset_field( "request", {
     name => "captcha",
@@ Line 13: / Line 17: @@
     type => "recaptcha3",
   });
 == Inheritance ==