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

Overview

The X-Auth module allows your customers to log in to your store using their existing accounts with Facebook, Google, Twitter, Yahoo!, MySpace and other popular social networks. Thus, X-Auth can quickly convert the anonymous visitors to your registered customers. The registration process takes just a few mouse clicks and allows to instantly pass the required user details (such as name, email, address, etc.) to the account with the store and maintain that data current at all times. The key benefits of using X-Auth are:

• Fast sign in for the customer.
• Fast sign in for the staff of the store (admin/provider/affiliates).
• Linking multiple external profiles with a single profile at your store.

How X-Auth works

Once X-Auth is successfully installed, the customer sign-up interface has an option for logging in or signing up using one of the available authentication services. After selecting a service, customer confirms the linking of accounts in the external service and in X-Cart. A single X-Cart profile can be linked to multiple external profiles, and customer can use any of those profiles as desired.

If the external customer profile does not contain all the required information for registering with X-Cart, the system automatically prompts user to complete the profile by adding the missing data.

System requirements

To be able to successfully install and use X-Auth, you must have a working copy of X-Cart Gold or X-Cart Pro already installed on your server. Make sure that the version of the X-Auth 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 Summary/Environment info section of the X-Cart Admin area (select Administration -> Summary) on the menu.

Installation

The instructions on how to install the X-Auth add-on module are the same both for X-Cart Gold and X-Cart Pro.

To install the module:

1. Obtain a distribution package for the X-Auth add-on module by downloading it from the File Area section of your X-Cart Account. The distribution package you need is contained in the archive file xauth-x.y.z.tgz where x, y and z are the version numbers of the module. Make sure the version of the module is the same as the version of the installed copy of X-Cart.

2. Put 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) Decompress the archive with the X-Auth distribution package to a directory on your system using your favorite compression program (WinZIP or any other archiver with support for TAR files).

b) Use an FTP client to upload all the files contained in the archive (retaining the directory structure) to the X-Cart root directory on your server or your hosting account.

• If you use a UNIX-based server with terminal access:

a) Use an FTP client to upload the archive with the distribution package to the X-Cart root directory on your server or your hosting account.

b) Decompress the package using the following commands.

tar -xzvf xauth-x.y.z.tgz

Important: Make sure you keep the directory structure while unpacking and uploading the distribution package, otherwise some necessary files can be overwritten!

3. In a web browser, run the installation script httр://<YOUR_XCART_DOMAIN>/install-xauth.php replacing the variable <YOUR_XCART_DOMAIN> with the true name of the domain where X-Cart is installed.

4. Enter the Auth code, accept the License Agreement and click the Next button.

Note: The Auth code is a random code that was generated after you installed your copy of X-Cart. If you do not remember the Auth code, find it in the Summary section of the X-Cart Admin area (Administration menu->Summary) before the License info subsection. Another way to know the code is to retrieve the value of the variable $installation_auth_code from the file <xcart_dir>include/install.php .

5. The installation script copies the files and activates the module. Click the Next button to continue the installation.

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.

Uninstalling X-Auth

The instructions on how to uninstall the X-Auth add-on module are the same both for X-Cart Gold and X-Cart Pro.

To uninstall the X-Auth add-on module:

1. In a web browser, run the installation script http://www.example.com/install-xauth.php replacing "www.example.com" with the true name of the domain where X-Cart is installed.

2. Choose the Uninstall the module option, enter the Auth code, accept the License Agreement and click the Next button.

Note: The Auth code is a random code that was generated after you installed your copy of X-Cart. If you do not remember the Auth code, find it in the Summary section of the X-Cart Admin area (Administration menu->Summary) before the License info subsection. Another way to know the code is to retrieve the value of the variable $installation_auth_code from the file <xcart_dir>include/install.php .

3. After the installation script removes the module files and deactivates the module, click the Next button to complete the uninstallation.

4. At the Uninstallation complete screen, click Next to leave the Wizard.

Important: After you have uninstalled X-Auth, be sure to remove the module distribution package from your web directory.

Enabling

After you have installed the X-Auth add-on module, you need to enable it in the X-Cart Admin area. Otherwise you will not be able to use the module to launch an affiliate system in your store.

To enable the X-Auth add-on module:

1. Log in to the X-Cart Admin area and go to the Modules section (Administration menu -> Modules).
2. In the list of modules find the entry "XAuth" and select the corresponding check box.
3. Scroll down to the bottom of the page and click the Update button to apply the changes.

640px

After you have updated the list of active modules, the Configure link will appear next to the module name, meaning that the module is enabled. Use this link to go to the X-Auth configuration page and set up the module.

640px

Configuring

1.1 Перед тем как конфигурировать XAuth модуль в админ арии вам следует создать бесплатный аккаунт в janrain http://www.janrain.com/products/engage/get-janrain-engage

1.2 здесь нужно описать процесс регистрации на janrain

Если у вас уже есть janrain аккаунт то переходите к шагу 2.1

To configure the module:

1. Log in to the X-Cart Admin area and go to the X-Auth settings page.

To reach the configuration page use one of the methods below.

• Go to the section General settings/XAuth (Settings menu -> General settings).
• Go to the list of modules (Administration menu -> Modules) and click on the Configure link that corresponds to the entry "Affiliate".

You will see a box with a number of options and settings for the X-Auth module.

640px

2. Adjust the module settings.