Drupal 7

Updated February 9th 2018

Tested with Drupal 7 Version: 7.56

PixelPin OpenID Connect

Step-by-step installation guide

PixelPin OpenID Connect is a Drupal 7 Module for authenticating with PixelPin using the OpenID Connect API.

PixelPin OpenID Connect allows you to connect your website to PixelPin and let users authenticate using passwordless pictures. With PixelPin OpenID Connect module, your user's to log in to your website using their PixelPin pictures. With PixelPin OpenID Connect, user's will no longer need to complete numerous forms for a successful registration.

To complete the installation, you'll need to create your PixelPin developer account.

Dependencies

  1. PixelPin OpenID Connect requires the Drupal 7 Chaos tool suite module (ctools-7.x-1.12) and the Entity API module (entity-7.x-1.8). Download, install and enable these dependencies to require you to be able to enable and use PixelPin OpenID Connect. The dependencies will download in a .zip file. Once installed you only need to enable 'Chaos tools' and 'Entity API'.

Installation

  1. Log into the admin account of your Drupal 7 website and click on Modules.

  2. Click + install new module.

  3. Copy and paste the install url: https://ftp.drupal.org/files/projects/ppoidc-7.x-1.2.tar.gz into the Install from a URL input box. Click Install. Check the Plugin page for the latest versions.

  4. Click Enable newly added modules.

  5. Repeat steps 3 - 4 for Chaos tools (https://ftp.drupal.org/files/projects/ctools-7.x-1.13.tar.gz) and Entity API (https://ftp.drupal.org/files/projects/entity-7.x-1.8.tar.gz) modules.

  6. The page should open on the modules page. Scroll down until you find Chaos tools and Entity API (near the bottom). Check the checkboxes for each and then click save configuration at the bottom of the page. Then check the PixelPin OpenID Connect checkbox, and then click save configuration at the bottom of the page.

  7. All three modules are now installed.

Enabling PixelPin OpenID Connect

  1. Staying on the module page. Click configure next to PixelPin OpenID Connect.

  2. The page should open on the PixelPin OpenID Connect configuration page. Check the Enable checkbox to enable PixelPin OpenID Connect.

  3. The Client ID and Client Secret fields should appear along with the Redirect URI field which you'll need to create the PixelPin developer account required to use the PixelPin OpenID Connect module. If you haven't created a PixelPin developer account before, a guide can be found here to guide you throught the steps to create a PixelPin developer account.

  4. Once you've onbained your Client ID and Client Secret after creating a PixelPin developer account, type/paste them into the Client ID and Client Secret fields.

  5. (Optional) You can configure the styling of the PixelPin Single Sign On Button by changing the size, colour and content of the button.

  6. (Optional) You can configure where the user's data will be saved and which field it'll appear on. The PixelPin OpenID Connect automatically adds these fields with the preferred user claims mappings to save you time creating them.

  7. Remember to save the configuration by pressing Save configuration at the bottom of the page!

  8. You've now enabled PixelPin OpenID Connect on your Drupal 7 website.

Testing the module

Logging in on the front page

An additional button has been added to the front page sidebar. The user can log in and register using this button if they have a PixelPin Account.

Logging in on the log in page

An additional button has been added to the bottom of the login page. The user can log in and register using this button if they have a PixelPin Account.

Registration

An additional button has been added to the top of the registration page. The user would use this button to register of your website, saving time filling in all the fields themselves.

Existing Users

Existing users can connect their existing account to PixelPin to be able to log in using PixelPin. The user can find this when they click on my account then connected accounts.

Contributing

PixelPin OpenID Connect is an open-source project that allows developers using PixelPin to improve the plugin. The Github Repo can be found here.