HomeGuidesAPI
HomeGuidesRecipesAPI
HomeGuidesAPILog In

reCAPTCHA

Suggest Edits

Overview

reCAPTCHA is a Google free service that protects your website from spam and abuse. reCAPTCHA uses an advanced risk analysis engine and adaptive challenges to keep automated software from engaging in abusive activities on your site. It does this while letting your valid users pass through with ease.

Features

  • reCaptcha V2
  • TestMode
  • Light and dark reCaptcha themes

Release Notes

Release Update - 16 Mar, 2020

Version 1.0.1.0

Fixes

  • Fix to action inputs not working correctly

Release Update - 16 Apr, 2019

Version 1.0.0

Initial Release:

  • reCaptcha V2
  • Test mode
  • Light and Dark themes

Connector Components

  • reCaptcha Question Extension

Installation and Configuration

Creating a Google reCaptcha profile

  1. Navigate to https://www.google.com/recaptcha
  2. Click on Admin Console and login with your google account
  3. Provide required information as follows:
  • Label: meaninful name of this specific integration.
  • reCAPTCHA Type: Select reCAPTCHA v2 (v3 is not supported at this stage)
  • Domains: Add all relevant domains to be used with this specific integration.
  • Accept terms and conditions
  • Click Submit

Installation

  1. Copy the following files on SmartIQ Web Server under [<<productname>> Produce Path]:
  • reCaptchaQuestion.dll

  1. Using a text editor such as Notepad, open the following file: [<<productname>> Produce Path]\appsettings.json locate [Extensions] and add
    "reCaptchaQuestion.reCaptchaQuestion, reCaptchaQuestion"

  2. Using a web browser, navigate to the SmartIQ Produce application to allow the system to register the Connector.

  3. Validate if Content-Security-Policy rule is defined in [<<productname>> Produce Path]\web.config inside <httprotocol> <customHeader>. If that's the case,
    make sure you add: https://www.gstatic.com and https://www.google.com. Resulting line would be like:

<add name="Content-Security-Policy" value="default-src 'self' 'unsafe-inline' data: https://cdnjs.cloudflare.com https://maxcdn.bootstrapcdn.com https://*.googleapis.com https://fonts.gstatic.com https://www.gstatic.com https://www.google.com" />

The Connector should now be installed and ready for configuration.

Note: reCAPTCHA question requires a license key, make sure your SmartIQ Instance has Module Id: 9017 under Licensing

Configuration

Go to Manage Application, open Settings > Connector Settings > reCAPTCHA and provide the following information:

  • Default Site Key: Get this key from Google reCAPTCHA Admin Console.
  • Default Secret Key: Get this key from Google reCAPTCHA Admin Console.
  • Test Mode (True|False): Allows to skip reCAPTCHA for quick tests. This can also enabled using troubleshooting mode for one specific project.

Note: All of these individual settings are system wide parameters. It is also possible to define specific inputs per reCAPTCHA Question

Click Save.

Using reCAPTCHA Question Design

reCAPTCHA is a question that can be added at any point in a process. If you have already defined system wide properties for the Site Key and Secret Key there's no need to add the in design. By default, the question will use the Light Theme.

Question Inputs

Optional

  • Site Key: Get this key from Google reCAPTCHA Admin Console.
  • Secret Key: Get this key from Google reCAPTCHA Admin Console.
  • Theme: Allows to select Light or Dark themes.

To enable Test Mode for one specific project (instead of using the system wide option), just enable troubleshooting.

Question Extension Outputs

  • Success: [True|False] Before validation -> False, when reCAPTCHA is successful -> True.

Important Notes

  • reCAPTCHA Question cannot be directly referenced in a Form Summary. The Designer needs to map the response value to a label in order to make it a visible property.
  • reCAPTCHA Question is not recorded in the Interaction Log and Project Results.
  • reCAPTCHA v3 is not supported at this stage.

Updated over 3 years ago