|
|
| (95 intermediate revisions by 9 users not shown) |
| Line 1: |
Line 1: |
| − | ==Overview==
| + | #REDIRECT [[X-Cart:Social_Login_(former_Janrain_Engage)_module]] |
| − | | |
| − | | |
| − | 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.
| |
| − | | |
| − | [[Image:X-Auth_admin_01.gif|450px|center]]
| |
| − | | |
| − | 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.
| |
| − | | |
| − | [[Image:X-Auth_admin_02.gif|250px|center]]
| |
| − | | |
| − | == 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.
| |
| − | | |
| − | {{Note1|Note: If you do not remember the version of your copy of X-Cart, you can find it in the <u>Summary/Environment info</u> section of the X-Cart Admin area (select <u>Administration</u> -> <u>Summary</u>) on the menu.}}
| |
| − | | |
| − | ==Installation==
| |
| − | | |
| − | These instructions on installing the X-Auth add-on are the same for both X-Cart Gold and X-Cart Pro.
| |
| − | | |
| − | To install the X-Auth add-on:
| |
| − | | |
| − | 1. Obtain a distribution package for the X-Auth add-on by downloading it from the File Area section of your {{QA}} account. The distribution package is archived in a file <u>xauth-x.y.z.tgz</u>, where <u>x</u>, <u>y</u> and <u>z</u> 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 X-Auth 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 X-Auth distribution package to the X-Cart root directory on your server or hosting account.
| |
| − | | |
| − | : b) Decompress the package by typing the following command:
| |
| − | | |
| − | <pre>tar -xzvf xauth-x.y.z.tgz</pre>
| |
| − | | |
| − | {{Note1|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р://<YOUR_XCART_DOMAIN>/install-xauth.php, replacing the variable <YOUR_XCART_DOMAIN> 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.
| |
| − | | |
| − | {{Note1|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 (select <u>Tools</u>-><u>Summary</u> on the administration menu), right over the License info subsection. Another way to find out the code is to retrieve the value of the $installation_auth_code variable from the file <u><xcart_dir>include/install.php</u> .}}
| |
| − | | |
| − | 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.
| |
| − | | |
| − | ==Uninstalling X-Auth==
| |
| − | | |
| − | The instructions on uninstalling the X-Auth add-on are the same both for X-Cart Gold and X-Cart Pro.
| |
| − | | |
| − | To uninstall the X-Auth add-on:
| |
| − | | |
| − | 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 <u>Uninstall the module</u> option, enter the Auth code, accept the License Agreement and click the '''Next''' button.
| |
| − | | |
| − | {{Note1|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 (select <u>Tools</u>-><u>Summary</u> on the administration menu), right over the License info subsection. Another way to find out the code is to retrieve the value of the $installation_auth_code variable from the file <u><xcart_dir>include/install.php</u> .}}
| |
| − | | |
| − | 3. Once the installation script has removed the X-Auth files and deactivated the module, click the Next button to complete the uninstallation.
| |
| − | | |
| − | 4. On the <u>Uninstallation complete</u> screen, click '''Next''' to leave the Wizard.
| |
| − | | |
| − | {{Note1|Important: After you have uninstalled X-Auth, make sure to remove the module's distribution package from your web directory as well.}}
| |
| − | | |
| − | ==Enabling==
| |
| − | | |
| − | Once you have installed the X-Auth add-on, you should enable it in the X-Cart Admin area. Otherwise, you will be unable to use the module for launching the affiliate system at your store.
| |
| − | | |
| − | To enable the X-Auth add-on:
| |
| − | | |
| − | # Log in to the X-Cart Admin area and go to the <u>Modules</u> section (select <u>Settings</u> -> <u>Modules</u> on the administration menu).
| |
| − | # On the list of modules, find the "XAuth" item and select the check box by the item's name. | |
| − | # Scroll down to the bottom of the page and click the '''Update''' button to apply the changes.
| |
| − | | |
| − | [[Image:X-Auth_admin_03.gif|640px|center]] | |
| − | | |
| − | Once you have updated the list of active modules, X-Cart displays the <u>Configure</u> link next to the module name; that link indicates that the module is now enabled. Follow the link to go to the X-Auth configuration page and adjust the module's settings.
| |
| − | | |
| − | [[Image:X-Auth_admin_04.gif|640px|center]]
| |
| − | | |
| − | ==Configuring==
| |
| − | | |
| − | To configure the XAuth add-on in your Admin area, you must have an account with JanRain, an external authentication service that connects your store to the social networks.
| |
| − | | |
| − | // здесь нужно описать процесс регистрации на janrain
| |
| − | | |
| − | To get a free account:
| |
| − | | |
| − | # Visit http://www.janrain.com/products/engage/get-janrain-engage.
| |
| − | # Click on the logo of an identity provider (social network) where you have an existing account.
| |
| − | # On the sign-in page, enter your credentials for that identity provider and then click the 'Sign in' button.
| |
| − | # On the profile linking confirmation prompt, click 'Allow'.
| |
| − | | |
| − | That's it; you are in. If this is your first time at JanRain, you will be prompted to complete your profile with missing data, such as your name, company and e-mail address.
| |
| − | | |
| − | <Скрин формы дозаполнения данных>
| |
| − | | |
| − | Если у вас уже есть 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 <u>General settings</u>/<u>XAuth</u> (<u>Settings</u> menu -> <u>General settings</u>).
| |
| − | * Go to the list of modules (<u>Administration</u> menu -> <u>Modules</u>) 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.
| |
| − | | |
| − | [[Image:X-Auth_admin_05.gif|640px]]
| |
| − | | |
| − | 2. Adjust the module settings.
| |
