X-Cart:Social Login (former Janrain Engage) module

From X-Cart 4 Classic
Revision as of 15:24, 31 July 2015 by Dohtur (talk | contribs)
Jump to: navigation, search


The Social Login module is an add-on for integrating your X-Cart with Janrain’s services. The services allow your visitors with existing accounts with social networks – including Facebook, Twitter, Google, Yahoo! and LinkedIn and over a dozen of others – to quickly sign in to your online store via their existing social network accounts. The solution lets users bypass your traditional registration process and sign in with one click, resulting in an accelerated sign-up process for new users and a simple login experience for returning visitors.

Why Social Login

According to Consumer research study conducted by Blue Research in October 2011

Resistance to Traditional Registration Processes

  • Four in five (86%) people are bothered by the need to create new accounts when registering on a website and will change their behavior as a result; this represents an increase of more than 10% over the 2010 findings
  • 54% may leave the site or not return
  • 26% go to a different site, if possible
  • 6% leave/avoid the site
  • 14% say they will complete the registration
  • 88% admit to having given incorrect information or left forms incomplete when creating a new account at a website, up from 76% in 2010.
  • 9 in 10 people (90% versus 45% in 2010) admit they have left a website if they forgot their password or log-in info, instead of answering security questions or re-setting their password.

Irrelevant Targeting by Brands

  • 100% of respondents reported receiving information or promotions from companies that are not relevant to them
  • Almost 3 in 4 (74%) have received conflicting messages across different marketing channels
  • Two-thirds (66%) have received an offer that clearly shows a company does not know who they are
  • Over half have received offers targeted to the wrong name, gender or age

Increased Brand Affinity in Fans of Social Login

  • 77% believe social login is a good solution that should be offered, an increase of over 10% from the year prior (66% in 2010). Among that population…
  • 78% of social login fans have posted a comment or message to their social networks about a product or service they liked or thought others should know about or purchase
  • 4 in 5 people (83%) say they are influenced to consider buying new products or services based on positive comments or messages from people in their social network
  • 69% say positive reviews may increase their likelihood to purchase a product or service
  • 82% seek out or avoid companies based on reviews from friends in their social graph

Key benefits of using the Social Login module in X-Cart

  • Converts anonymous visitors into your registered customers.
  • Fast customer sign-in.
  • Fast personnel sign-in (admin/provider/affiliates).
  • Linking multiple external profiles with a single profile at your store.
  • Social Sharing – lets your users share comments, purchases or other activities from your site to their friends on multiple social networks.

On top of that, Janrain Engage allows your visitors to share their comments, purchases, reviews or other activities directly from your online store to their friends on multiple social networks, all without leaving your store. Social sharing with Janrain Engage lets you trigger sharing based on any number of user's actions, including purchases, posting comments, user-generated content or clicking a share button, enabling the word of mouth marketing for your business and transforming your users into brand advocates.

For more information on Janrain Engage, please visit Janrain Engage Online Home.

XC JR-01.png

System requirements and installation

Social Login is available as a built-in module in X-Cart GOLD PLUS and PLATINUM editions v4.5.3 and later. In the said editions, it does not require installation and can be enabled in the Modules section of X-Cart Admin area.

For X-Cart GOLD and PRO editions v4.1.12, 4.2.3, 4.3.2, 4.4.х and 4.5.х, this module can be purchased and installed separately. The following instructions will guide you through the process of installing the Social Login module in your store.

System requirements

To be able to successfully install and use the Social Login module, you need a working copy of X-Cart GOLD or PRO v4.1.12, 4.2.3, 4.3.2, 4.4.х or 4.5.х installed on your server. Make sure that the version of the Social Login integration module matches the version of your copy of X-Cart.

Note: If you do not remember the version of your copy of X-Cart, you can find it in the Environment info section of the Summary page in X-Cart Admin area.

Installation and removal

To install the Social Login module:

  1. Obtain a distribution package for the Social Login integration module by downloading it from the File Area section of your X-Cart Account account. The distribution package is archived in the file xauth-x.y.z.tgz, where x, y and z indicate the version of the module. Make sure the version of the module matches the version of your copy of X-Cart.
  2. Copy the distribution package to the X-Cart root directory on your server or hosting account.
    • If you use a Windows-based server or a UNIX-based server without terminal access:
    a) Extract the contents of the archive with the Social Login module files to a directory on your system using your favorite compression program (WinZIP or any other archiver that supports TAR files).
    b) Use an FTP client to upload all the files extracted from the archive (retaining the directory structure) to the X-Cart root directory on your server or hosting account.
    • If you use a UNIX-based server with terminal access:
    a) Use an FTP client to upload the archive with the Social Login module distribution package to the X-Cart root directory on your server or hosting account.
    b) Decompress the package by typing the following command:
    tar -xzvf xauth-x.y.z.tgz
    Important: Make sure that you maintain the directory structure while unpacking and uploading the distribution package; otherwise, some critical files can be overwritten!
  3. In a web browser, run the installation script at httр://www.example.com/install-xauth.php, replacing the variable www.example.com with the real domain name, where your X-Cart is installed.
  4. Enter the Auth code, accept the License Agreement and click the Next button.
  5. The installation script copies the files and activates the module. Click the Next button to continue.
  6. The installation script generates a new system fingerprint. Click the Next button to complete the installation.
  7. Use the ADMINISTRATOR AREA link to log in to the Admin area.

To uninstall the Social Login module:

  1. In a web browser, run the installation script at http://www.example.com/install-xauth.php, replacing the "www.example.com" with the real domain name, where your X-Cart is installed.
  2. Choose the Uninstall the module option, enter the Auth code, accept the License Agreement and click the Next button.
  3. Once the installation script has removed the Social Login module files and deactivated the module, click the Next button to complete the uninstallation.
  4. On the Uninstallation complete screen, click Next to leave the Wizard.
    Important: After you have uninstalled the Social Login module, make sure to remove the module's distribution package from your web directory as well.

Enabling the Social Login Module in X-Cart

Once you have installed the Social Login module, enable it in your store's Admin area.

To enable the Social Login module:

  1. Log in to the X-Cart Admin area and go to the Modules section (Settings menu->Modules).
  2. In the list of modules, find the Social Login item and select the check box next to it.
  3. Click the Apply changes button to apply the changes.

Now you can leave alone your X-Cart for a few moments and switch to Janrain.

Setting up Janrain

To be able to use the Social Login module, start by completing the following steps:

Once you're done with the above steps, proceed to configuring Social Login in your X-Cart store's Admin back end.

Creating a Janrain Engage account

The Social Login solution by Janrain is available on subscription basis. There are several subscription plans with different pricing levels, including a free basic plan. You can choose a plan that best suits your needs depending on the expected number of users per year. For example, you could choose the free basic plan to get you started and then, as your business grows, upgrade to a more advanced plan.

To sign up for Janrain Social Login:

  1. Visit the Janrain website and choose the subscription plan you require. Click on the Sign Up link for that plan.
  2. On the page that opens, sign in to Janrain using social login via Google, Facebook, Twitter, etc:
    Xc4 sl social auth.png

    or choose to create a new account from scratch:
    Xc4 sl janrain auth.png

  3. On the following screen, complete the registration form with your information (your first name, last name, e-mail address, phone, company, job title, etc.) and click Create Account.
    Xc4 sl create janrain account.png

    At this point an email verification message should be sent to the email address you provided. Click on the email verification link in that message and sign in to Janrain:
    Xc4 sl welcome 2 janrain.png

    Once you're signed in, you should be ready to set up your first Janrain application.
    Xc4 sl looks like youre new.png

Creating a Social Login application

To create an application:

  1. Visit the dashboard.janrain.com site and log in.
  2. Choose to create a new property:
    Xc4 sl create property.png

  3. Click Create an App opposite the Engage item:
    Xc4 sl create property1.png

    A popup window for creating an application opens.
    Xc4 sl create application.png

  4. Enter the desired application name and click the Create Application button.
    Xc4 sl create application1.png
    (Be sure to use a recognizable name for the appication so your customers will associate it with your store; this name will be displayed on the identity providers’ sign-in or permission screen when your customers will be signing in to your website).
    Important: DO NOT enter your website URL into the Application Name field!)

    The Janrain servers generate the application you’ve created.
    That is all; you now have an application that will allow you to use Social Login at your store.
    :Xc4 sl thanks signing up.png

    Now you can click the 'Get started' button to continue. The next step will be to configure your application.

Next step: Configuring your Janrain Social Login application

The first step to deploy Social Login on your website is to configure your Social Login providers (i.e. select which identity providers will be offered to the user on your site and specify the types of user data that each provider should be able to access).
To configure your Social Login providers, do the following:

  1. Sign in to your Janrain Social Login application.
  2. Click the Manage Engage App button for your application to access the application settings on the Janrain Dashboard.
    Xc4 sl manage engage app.png

  3. On the Dashboard, click Sign-Ins under the Widgets and SDKs menu:
    Xc4 sl signins.png

  4. On the Configure Widget screen, select the Providers tab:
    Xc4 sl providers tab.png

  5. Add to your widget the identity providers with which your website users should be able to sign in. For every provider, complete the following steps:
    1. Click the gear icon next to the provider name:
      Xc4 sl provider gear icon.png

      This launches the provider configuration wizard. For example, in the screenshot below you can see the first step of the configuration wizard for Facebook setup:
      Facebook instr1.png

    2. Follow the wizard instructions to complete the configuration. A detailed guide for how to complete Facebook setup is available in the Facebook setup section below.
    3. Once the configuration has been completed, close the wizard window and add the provider you have configured to your widget by dragging it to the central area of the screen into one of the empty slots:
      Xc4 sl drag facebook.png

    4. Save the changes by clicking the Save button at the bottom.
      Xc4 sl provider save.png

  6. Configure appropriate permissions for each of the providers you have added:
    1. On the Dashboard, locate the provider for which you need to configure permissions in the Providers menu. Hover your mouse pointer over the provider name to reveal the Manage permissions for <provider name> button. Click this button.
      Xc4 sl manage permissions facebook.png

    2. Enable the types of data the provider should be able to access.
      For example, let's configure permissions for Facebook: Click on the "Off" switch next to "Email":
      Xc4 sl facebook email.png

      The grey "Off" switch now turns to a green "Ask" label. Note that enabling the permission "Email" automatically enables "Verified Email" as well.
      Xc4 sl facebook email ask.png

  7. To add social sharing capabilities for the users of your website, configure social sharing:
    1. On the Dashboard, click Sharing under the Widgets and SDKs menu:
      Xc4 sl sharing.png

    2. Select the providers you would like to use for social sharing.
      Xc4 sl sharing providers select.png

      If a provider is a "non-native" one and requires configuration, before selecting the provider click the gear icon next to the provider's name on the left and configure it.
    3. Make sure each social sharing provider you enabled has appropriate permissions. For example, if you are configuring Gmail, you must request the Contacts and Email Sharing scopes from your Google+ provider configuration page.

That is all; now you can proceed to configuring Social Login in your X-Cart store's Admin back end.

Facebook setup

The following procedure provides detailed instructions for setting up a Facebook application for use with Janrain Social Login. When configuring Social Login via Facebook, please follow these instructions at Step 5.2 of the Configuring your Janrain Social Login application procedure.

  1. Sign in to your Facebook account and go to developers.facebook.com/apps. Allow "Developer" access to your account if prompted.
  2. Create your Facebook application and save it:
    1. Click Add a New App:
      Facebook add new app.png

    2. Select the platform "Website":
      :Facebook add new app website.png

    3. On the next screen, choose Skip and Create App ID:
      Facebook skip.png

    4. On the Create a New App ID screen, enter a name for your Facebook app and set the Category setting to "Apps for Pages":
      Facebook create app id.png

    5. Click Create App ID. Once you do so, Facebook usually provides some kind of test as a security check for protection against automated app id registrations; so do that test as well. If successful, Facebook generates your App ID, and now you should be looking at the Facebok Dashboard with the details of your app:
      Facebook dashboard.png

  3. Configure the Facebook application you have created:
    1. Click Settings in the left navigation.
    2. Insert into the appropriate fields the values that the Facebook setup wizard on the Janrain site tells you to copy and paste to Facebook. In our case, the wizard tells us to copy and paste the Site URL https://my-x-cart-store.rpxnow.com (the App Domain for our Janrain application):
      Facebook instr3.png

      So, that's exactly what we'll do. Let's click + Add Platform:
      Facebook settings add platform.png

      select the platform "Website":
      Facebook platform website.png

      and paste our Janrain app domain value to the Site URL field:
      Facebook site url.png

    3. Save your changes by clicking Save Changes at the bottom of the Facebook form.
    4. Click App Details in the left navigation.
      Facebook app details.png

    5. Configure your Facebook application details as suggested by the Facebook setup wizard on the Janrain site.
      Facebook instr4.png

    6. Save your changes by clicking Save Changes at the bottom of the Facebook form.

  4. Connect your Facebook application to your Janrain Social Login application:
    1. Click Settings in the left navigation.
    2. Locate your Facebook App ID and App Secret values (You will need to click the Show button to reveal the App Secret value):
      Facebook appid appsecret.png

    3. Copy and paste these values one by one into the fields on the Janrain site:
      Facebook instr5.png

    4. Click Save:
      Facebook instr6.png

      This enables Facebook:
      Facebook instr7.png

You can now click the Close button to quit the Facebook configuration wizard and continue setting up your Janrain application starting from Step 5.3.

Configuring Social Login in your X-Cart store's Admin back end

Now, tell your X-Cart what it should do with all the stuff you have just set up -- configure the Social Login module that you enabled in your store a few steps earlier.

To configure the Social Login module:

  1. Log in to the X-Cart Admin area.
  2. Select Settings -> Modules on the menu.
  3. Scroll down until you see the Social Login module item and click on the Configure link opposite it. The Social Login module configuration page opens.
    Social login settings.png
  4. Adjust the Social Login module configuration settings and click the Apply changes button.

Social Login module configuration settings

Here are a few notes on the Social Login module configuration settings:

  • API key and Application ID: These values can be obtained on the Deployment->Application Settings page in your Janrain Dashboard.
  • Application name: This is the name of the application you created for your store.
  • Display mode: This setting defines the layout of the user login block.
    The Horizontal option produces the following result:
    The Vertical option gives the following result:

Administrator sign-in over identity providers

To enable signing in as administrator over an external identity provider:

  1. Sign in to your X-Cart store using your regular credentials.
  2. In the X-Cart Admin area, click on the administrator profile link at the top of the page.
  3. On the Account details page, click on the 'Add an identifier' link.
  4. Sign-in using your preferred identity provider.

Adding Social Sharing to your online store

To add the Social Sharing widget to your online store:

  1. On the Janrain Dashboard page, select Deployment -> Social Sharing for Web on the menu.
  2. Follow the instructions provided on the Social Widget Setup page for adding the social widget to your online store.

For more information on creating and using activity objects, please refer to Janrain's social sharing documentation.


Error: Whoops, you've been directed here by mistake

The 'Application name' specified in X-Cart admin back end on the module configuration page is incorrect. Janrain replaces dots with dashes, thus to fix the issue you should do the same, e.g. if your app name is yourappname.domain:

yourappname.domain -> yourappname-domain

You should specify "yourappname-domain" as an 'Application name' in X-Cart.