Draft:X-Cart:Pay with Amazon

From X-Cart 4 Classic
Revision as of 15:55, 25 January 2014 by Dohtur (talk | contribs) (→‎Getting started with X-Cart's Pay with Amazon module)
Jump to: navigation, search

Overview

Pay with Amazon

Getting started with X-Cart's Pay with Amazon module

  1. Register for Amazon Payments Advanced service.
    Note: Amazon Payments Advanced is an Amazon service that is separate from Checkout by Amazon (CBA) solution. That means you’ll need to go through a registration process, even if you have an existing CBA account.

    You can register for Amazon Payments Advanced using this link: Get started now >
  2. Login to Amazon's Seller Central at https://sellercentral.amazon.com to complete a few extra steps. If you’ve registered for multiple Amazon services, you’ll see a dropdown at the top of the page that lets you move between the different services.

System requirements and installation

To be able to successfully install and use the Pay with Amazon module, you need a working copy of X-Cart version 4.6.2 installed on your server.

Note: If you do not remember the version of X-Cart on which your store is based, you can look it up in the Environment info section of the Summary page in X-Cart Admin area.

To install the module:

  1. Download the Pay with Amazon module archive from the File Area section of your X-Cart Account. Look for a file named like x-pay-with-amazon-x.y.z.tgz, where x, y and z are numbers matching the version of your installed copy of X-Cart.
  2. Copy the contents of the module achive to the X-Cart root directory on your server or hosting account.
    • If you are using a Windows-based server, or a UNIX-based server without terminal access:
    a) Unpack the module archive to a directory on your system using your favorite compression program (WinZIP, 7-Zip or any other archiver with support for TAR files).
    b) Use an FTP client to upload all the files contained in this directory (retaining the directory structure) to the X-Cart root directory on your server or your hosting account.
    • If you are using a UNIX-based server with terminal access:
    a) Use an FTP client to upload the module archive to the X-Cart root directory on your server or your hosting account.
    b) Unpack the archive using the following command:
    tar -xzvf x-pay-with-amazon-x.y.z.tgz
    (Replace x, y and z with the actual version numbers).
    Important: Make sure you keep the directory structure while unpacking and uploading the module archive, otherwise some necessary files may be overwritten!
  3. In a web browser, run the installation script httр://<YOUR_XCART_DOMAIN>/install-pay-with-amazon.php replacing <YOUR_XCART_DOMAIN> with the actual domain name of your X-Cart store. This will start the installation wizard. A screen like the following will be displayed:
    PwA install.png

  4. Carefully read the License agreement, enter the Auth code for your X-Cart installation into the Auth code field and select the "I accept the License Agreement" check box:
    PwA install1.png

  5. Click Next to continue. The installation process will start. The installer will make the necessary changes to your X-Cart installation, and the module will be activated:
    PwA install2.png

    Note: If you are using a custom skin, you will need to patch it manually. Otherwise, the module will not work in this skin.
  6. Once the process is completed, click Next. This will open the next screen where you will be asked whether you wish a new system fingerprint to be generated:
    PwA install3.png

  7. Make your selection (Yes/No) and click Next. If you have chosen to generate a new system fingerprint, it will be generated. The process of generating a system fingerprint may take up as long as a few minutes. Once the generation process is completed, click Next. If you have chosen to skip the generation of a system fingerprint, you will be taken to the next step.
  8. After clicking Next you should see the "Installation complete" screen:
    PwA install4.png

    This is the final step. It informs you that the Pay with Amazon module has been installed successfully. It also reminds you to remove the module archive file in case you put it in a web accessible directory; this is needed to protect the module from unauthorized copying.
    Important: At the final step of the installation process, the installation script install-pay-with-amazon.php is automatically renamed as an additional measure to protect the module installation. Please take note of the filename to which the installation script was renamed. If you decide to re-install or uninstall the module later on, you will need to rename the installation script back to install-pay-with-amazon.php before launching the installation process in your web browser.

Now if you choose to view the list of your store's installed modules (this can be done using the Administrator area link provided on the "Installation complete" screen), the Pay with Amazon module will be on the list:

PwA modules list.png

Note that after the module has been installed, it is already in the enabled (active) state. You can temporarily disable the module using the module deactivation instructions from the section Activating and deactivating the Pay with Amazon module below.

Before you can start using the module, you need to configure it. See Configuring the Pay with Amazon module.

Uninstallation

Uninstallation completely removes all the data related to Pay with Amazon module from your store.

To complete the uninstallation, you will need to run the Pay with Amazon module installation script. You might remember that, after the module was installed in your store, the script was saved with a new name to help prevent unauthorised runs of the installer. Now, before you start, you need to rename the script back to its original name - install-pay-with-amazon.php.

To uninstall the module:

  1. Run the module installation script in your web browser by going to httр://<YOUR_XCART_DOMAIN>/install-pay-with-amazon.php (be sure to replace the <YOUR_XCART_DOMAIN> part with the actual domain name of your X-Cart store). This will start the installation wizard. A screen like the following will be displayed:
    PwA uninstall.png

  2. Select "Uninstall the module", enter the Auth code for your X-Cart installation into the Auth code field and select the "I accept the License Agreement" check box:
    PwA uninstall1.png

  3. Click Next to continue. The uninstallation process will start. The installer will make the necessary changes to your X-Cart installation, and the module will be deactivated:
    PwA uninstall2.png

  4. Once the process is completed, click Next. This will open the next screen where you will be able to generate a new system fingerprint.
  5. Generate the system fingerprint (or skip it). After clicking Next you should see the "Uninstallation complete" screen:
    PwA uninstall3.png

    This is all. The Pay with Amazon module has been uninstalled.

Activating and deactivating the module

If the module Pay with Amazon is installed, but not active, you can enable (activate) it.

To enable the module:

  1. Go to the Modules section of your store's Admin area (Settings menu->Modules). This opens the list of your store's installed modules.
  2. Locate the entry for the Pay with Amazon module and select the respective check box on the left.
  3. Click Apply changes. The module will be enabled.

It is possible to temporarily disable (deactivate) the installed Pay with Amazon module. Deactivation stops the module from operation, but it does not remove any settings you made to the module configuration nor clear any data that was generated during the period that the module was in operation. If you wish to completely remove all the data related to using the module, you need to uninstall it. See Uninstallation for more info.

To disable the module:

  1. Go to the Modules section of your store's Admin area (Settings menu->Modules).
  2. Locate the entry for the Pay with Amazon module and unselect the respective check box on the left.
  3. Click Apply changes. The module will be disabled.

Configuring the module

After the module has been installed and enabled, it needs to be configured.

To configure the module:

  1. Open to the module configuration section. Use one of the following methods:
    • In the Modules section of your store's Admin area (Settings menu->Modules), locate the entry for 'Pay with Amazon' module and click the Configure link next to it:
      PwA configure.png

      OR:
    • In the Payment methods section of your store's Admin area (Settings menu->Payment methods), click the 'Pay with Amazon' tab:
      PwA tab.png

      The Pay with Amazon module configuration section looks like the following:
      PwA settings1.png

Retrieved from "https://help.x-cart.com/index.php?title=Draft:X-Cart:Pay_with_Amazon&oldid=12224"