Skip to content

XRPL-Labs/Nop.Plugin.ExternalAuth.Xumm

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Xumm External Authentication plugin for nopCommerce

Easy Configuration

  1. Sign up for a Xumm Developer account, if you don't already have one.
  2. Install the plugin in nopCommerce.
  3. Configure the API Credentials and set the Redirect URI's of the stores that should enable Xumm authentication.
  4. Request static email addresses.
  5. You're all set to use Xumm for external authentication.

Instructions

Step 1: Register a Xumm Developer account

Sign up for a Xumm Developer account, if you don't already have one.

Once you have access to the Xumm Developer Dashboard, you will be able to create an application with the required API Credentials.

The credentials can be found inside the Xumm Developer Dashboard > Settings > Application credentials section.

After that, please update your Redirect URI's with https://<your-store-url>/signin-xumm in the Application details section.

Step 2: Install the plugin in nopCommerce

The Xumm Pay plugin is not (yet) available in the nopCommerce Marketplace so you need to create a folder ExternalAuth.Xumm in the nopCommerce Plugins folder and copy the contents of src.

More details can be found in the nopCommerce Documentation.

Step 3: Configuration Xumm plugin

After installing the plugin, you can navigate to Configuration > Authentication > External authentication on the navigation menu of the admin panel.

You will be able to see “Xumm authentication” on the list, click Configure.

API Settings

API Credentials

First you need to configure the API Key and Secret found of the Application credentials section at the Developer Dashboard.

Redirect URI

Update the Redirect URI's list at the Application details section of the Developer Dashboard with the Redirect URI's shown at the plugin configuration page.

Step 4: Static Email addresses

After a successful sign in the email address returned by the Xumm OAuth2 platform will allow emails to be received for 10 minutes after the successful login. An email delivered to the unique email address for the specific Xumm App + user (r-address) will be stripped, and served plain text to the end user. The end user will receive a push notification and event in Xumm serving the email. (Links, images, attachments, etc. will be stripped out).

The user won't be able to login a second time after the email has changed so we need to enable static email addresses for your Xumm Application(s). Please send an email to dominique@xrpl-labs.com with the request to enable static email addresses including the API Key's used with this plugin.

Step 5: Validate Xumm authentication

The API Key, API Secret and Redirect URI has to be configured as required.

The Xumm authentication method will not be visible at the login page for consumers if not configured correctly.