Skip to content

Enhance reCAPTCHA documentation to include support for reCAPTCHA Enterprise#787

Open
fnhipster wants to merge 1 commit intodevelopfrom
recaptcha-update
Open

Enhance reCAPTCHA documentation to include support for reCAPTCHA Enterprise#787
fnhipster wants to merge 1 commit intodevelopfrom
recaptcha-update

Conversation

@fnhipster
Copy link
Contributor

Purpose of this pull request

This pull request rewrites the reCAPTCHA integration documentation to reflect the addition of reCAPTCHA Enterprise support introduced in StorefrontSDK PR #189. The existing docs were outdated — they stated only v3 was supported, showed incorrect setConfig usage (passing a config object instead of a PropsFormTypes[] array), and lacked guidance for Enterprise, custom forms, and debugging.

Key changes:

  • Updated supported versions: v3 Invisible and Enterprise
  • Fixed setConfig API documentation — correctly documents the PropsFormTypes[] signature and clarifies that configList entries are additive badge containers, not backend config overrides
  • Added mandatory calling order: setEndpointsetConfiginitReCaptchaverifyReCaptcha
  • Added initReCaptcha delay parameter documentation (lazyLoadTimeout, default 3000ms)
  • Added custom form integration section with end-to-end code example
  • Added mixed reCAPTCHA types caution (module disables reCAPTCHA when both v3 and Enterprise are configured)
  • Improved enableLogger section with [ReCaptcha] prefix details and lifecycle coverage
  • Added Limitations section (mixed types, empty website_key handling, future per-form type support)

Associated JIRA ticket

Staging preview

Affected pages

Links to source code

What's New highlights

  • reCAPTCHA Enterprise support: The reCAPTCHA module now supports both reCAPTCHA v3 Invisible and reCAPTCHA Enterprise. The module automatically detects the configured type from Commerce Admin via the recaptchaFormConfig GraphQL endpoint and loads the appropriate Google script (api.js or enterprise.js). No changes required for existing v3 integrations.
  • Custom form integration guide: New documentation section with step-by-step instructions for integrating reCAPTCHA into custom forms not natively covered by Adobe Commerce, including badge container creation and token retrieval.

…rprise, update integration steps, and clarify usage guidelines for custom forms. Add caution regarding mixed reCAPTCHA types and improve overall structure for better clarity.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant