Skip to main content

Integration in OXID eShop

Use our module for OXID eShop to automatically integrate POWER CAPTCHA into your shop. You can individually select the areas or forms that should be protected.

The following sections / forms are currently supported:

  • Login forms
  • Registration forms
  • Checkout completion
  • Contact form
  • Password reset form
  • Newsletter form
  • Wished price form

The following describes how to install, activate and configure our OXID module.

Preconditions​

  • You have purchased a POWER CAPTCHA license and entered the domain of your store in the “My account” section on power-captcha.com (see Getting started).
  • You have installed OXID eShop in version 6.5 or 7.1.
  • You use one of the default themes (APEX, Flow, Wave, Azure) or a child theme. When using custom themes, modifications may be necessary.

Install the module​

The module is installed on commandline via Composer.

  1. First open an SSH connection with the server on which the shop is installed.

  2. Navigate to the root directory of your shop. You can identify the root directory as it contains the composer.json file, among other things. Example:

cd /var/www/oxideshop/

  1. To download and install the module, execute one of the following commands in the root directory - depending on the OXID version used:

    OXID 7.1

    composer require power-captcha/integration-oxid-eshop:^2.0.0

    OXID 6.5

    composer require power-captcha/integration-oxid-eshop:^1.0.0

Once the installation process is complete, the module is displayed in the OXID administration under “Extension ⇨ Modules”.

Activate the module​

  1. Log in to the administration area of your shop. Click on “Extension” in the navigation on the left-hand side and then on “Modules” (see illustration).

    Menu item 'Modules' highlighted in the OXID eShop administration area

  2. The module list opens in the right-hand area. Click on the module “POWER CAPTCHA Integration for OXID eShop” (see illustration).

    Module overview in the OXID eShop administration area, POWER CAPTCHA module highlighted

  3. The “Overview” tab of the POWER CAPTCHA module is displayed in the area below. Click on the “Activate” button there. The button is located on the right-hand side of the screen (see illustration).

    Tab 'Main' of the POWER CAPTCHA module, 'Activate' button highlighted

Once the module has been activated, a green checkmark is displayed next to the POWER CAPTCHA module in the module list (see illustration).

Module overview with active POWER CAPTCHA module, green checkmark highlighted

Configure the module​

In order for the module to function, an API key and a secret key must be specified in the module settings.

Furthermore, sections / forms that you want to protect with POWER CAPTCHA must be selected in the module settings.

  1. Navigate to the administration area “Extension ⇨ Modules” and click on the POWER CAPTCHA module in the module list.

  2. Then click on the “Settings” tab (see illustration).

    Tab 'Settings' of the POWER CAPTCHA module highlighted

  3. The settings page of the POWER CAPTCHA module opens. Click on “General settings” to display the settings fields (see illustration).

    Settings of the POWER CAPTCHA module, 'General settings' section highlighted

  4. Enter your POWER CAPTCHA API key in the “API Key” field and your secret key in the “Secret Key” field (see illustration).

    Settings of the POWER CAPTCHA module, 'General settings' section with filled API key and secret key highlighted

    Note

    You can find the API key and secret key in the “My account” section on power-captcha.com under the menu item API Keys (see illustration).

    Menu item 'API Keys' with displayed API key and secret key in the POWER CAPTCHA My account area

    Please also make sure that the domain of your website is entered in the “Domain / hostname” field.

    Further information can be found in our FAQ.

  5. If needed, you can also define the check mode and the behavior in case of API errors in the general settings, as well as activate the debug mode. Further information about the settings is displayed when you click on the “?” symbol next to the each settings field.

  6. Now click on “Protected areas / forms” to select which sections or forms of your shop should be protected with POWER CAPTCHA (see illustration).

    Settings of the POWER CAPTCHA module, 'Protected areas / forms' section highlighted

  7. Select the checkbox for the sections or forms that should be protected with POWER CAPTCHA. For example, “Contact form” and “Newsletter form” (see illustration). You can find further information to each section by clicking on the “?” symbol.

    Settings of the POWER CAPTCHA module, selection of 'Contact form' and 'Newsletter form' in the 'Protected areas / forms' section

  8. Once you have entered your API key and secret key and selected the protected sections, you can click on the “Save” button at the bottom to apply the settings (see illustration).

Settings of the POWER CAPTCHA module, 'Save' button highlighted

Note

The settings under “On-premises settings” are only relevant if you are using an on-premises solution with a self-hosted POWER CAPTCHA endpoint. Normally, you can leave both fields empty.

Result​

Once you have configured the POWER CAPTCHA module, the POWER CAPTCHA widget is displayed in the selected sections or forms (in case the check mode is set to “Automatic” or “Manual”). An example is shown below for the newsletter form.

OXID eShop newsletter form with integrated POWER CAPTCHA