Difference between revisions of "X-Cart:Affiliate"

From X-Cart 4 Classic
Jump to: navigation, search
(Overview)
(Installation)
Line 35: Line 35:
  
 
==Installation==
 
==Installation==
 +
 +
== System requirements ==
 +
 +
To be able to successfully install and use X-Affiliate 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 module is the same as the version of the installed copy of X-Cart.
 +
 +
{{Note1|Note: If you do not remember the version of the installed copy of X-Cart, find it in the <u>Summary/Environment info</u> section of the X-Cart Admin area (<u>Administration</u> menu -> <u>Summary</u>).}} Installing X-Affiliate
 +
 +
The instructions on how to install the X-Affiliate 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-Affiliate add-on module by downloading it from the File Area section of your {{QA}}. The distribution package you need is contained in the archive file <u>xaff-x.y.z.tgz</u> where <u>x</u>, <u>y</u> and <u>z</u> 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-Affiliate 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.
 +
 +
<pre>tar -xzvf xaff-x.y.z.tgz</pre>
 +
 +
{{Note1|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 http://<YOUR_XCART_DOMAIN>/install-xaom.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.
 +
 +
{{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 (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 <u><xcart_dir>include/install.php</u> .}}
 +
 +
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.
 +
 +
 +
 +
The instructions on how to uninstall the X-Affiliate add-on module are the same both for X-Cart Gold and X-Cart Pro.
 +
 +
To uninstall the X-Affiliate add-on module:
 +
 +
# In a web browser, run the installation script http://<YOUR_XCART_DOMAIN>/install-xaom.php replacing the variable <YOUR_XCART_DOMAIN> with the true name of the domain where X-Cart is installed.
 +
# 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 (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 <u><xcart_dir>include/install.php</u> .}}
 +
 +
# After the installation script removes the module files and deactivates the module, click the Next button to complete the uninstallation.
 +
# At the <u>Uninstallation complete</u> screen, click the Next button to leave the Wizard.
 +
 +
{{Note1|Important: After you have uninstalled X-Affiliate, be sure to remove the module distribution package from your web directory.}}
  
 
==Uninstalling X-Affiliate==
 
==Uninstalling X-Affiliate==

Revision as of 13:03, 25 January 2010

Overview

X-Affiliate enables you to launch a full-featured affiliate program in your store, which can help you advertise your store and the products you sell. When the affiliate program works, your store takes the main advantage of the Internet marketing, which is to distribute information to global audience at comparatively low price: You promote your store not only with the help of your store management team, but also through a network of your affiliates who get commission for the sales they promote. This will certainly make your online business more competitive.

With X-Affiliate you can manage your partners' accounts, calculate and track partner commission, create affiliate banners and links, collect versatile affiliate statistics, build a multi-level marketing system and even take closer control of third-party advertising campaigns in which your online store may take part.

The key X-Affiliate features are:

  • Unlimited number of affiliate partners of different levels.
  • Unlimited number of affiliate plans.
  • Ability to setup product- and category-based commission.
  • Full control of your partners' commission.
  • Control of third-party advertising programs.
  • Adjustable email notification.

How X-Affiliate works

In general, the idea of how the affiliate program built with X-Affiliate should work is as follows: The store administrator creates an affiliate plan and defines the rules on how to calculate commission for the plan, then the administrator creates a number of affiliate banners and allows new affiliates to register. A new affiliate partner gets registered in the affiliate program, subscribes to the affiliate plan and gets access to the special interface where the partner can generate the codes for the affiliate banners created by the store administrator. The partner then includes the banners into third-party resources on the Internet, companion websites, newsletters, forum signatures, bulletin boards, etc. When a new buyer comes to the store through a banner placed by the partner, the partner receives a percentage of the store's earning according to the rules in the affiliate plan which the partner is subscribed to. The commission goes to the partner's account automatically. The administrator then pays the commission to the partner in any preferable manner - X-Cart and X-Affiliate do not interfere with payment process in any way. After the partner commission has been paid off, the administrator should mark it as paid.

Since X-Affiliate is an add-on module, it can be used together with the X-Cart shopping cart only. When the module is installed and activated, it adds a number of new controls to the X-Cart Admin area and a new user interface, Partner area, and introduces a new type of user, Partner.

New controls in the Admin area allow the store administrator to manage all the aspects of the affiliate program. The majority of controls can be accessed through the special menu Affiliates, which is shown in the picture below. Other controls introduced by X-Affiliate are smoothly built into the basic X-Cart controls.


X-affiliate admin 01.gif


Partner area is a special password-protected user interface with the URL like www.example.com/xcart/partner/ where www.example.com/xcart/ is the URL to where X-Cart is installed. The Partner area is used by your affiliates to access different resources, including codes of affiliate banners and links, sales statistics, payment details, etc. To access the Partner area one must be a registered member of your affiliate program. The Partner area is shown in the picture below.


X-affiliate admin 02.gif


Partner is a user who registered to participate in your affiliate program. A partner can log in to the personal account in the Partner area, get assigned to an affiliate plan and earn commission for promoting your products, and even recruit his or her own affiliates and receive a part of their earnings if they promote a sale as well. The number of partners of all levels is unlimited.

Installation

System requirements

To be able to successfully install and use X-Affiliate 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 module is the same as the version of the installed copy of X-Cart.

Note: If you do not remember the version of the installed copy of X-Cart, find it in the Summary/Environment info section of the X-Cart Admin area (Administration menu -> Summary).

Installing X-Affiliate

The instructions on how to install the X-Affiliate 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-Affiliate 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 xaff-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-Affiliate 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 xaff-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 http://<YOUR_XCART_DOMAIN>/install-xaom.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.


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

To uninstall the X-Affiliate add-on module:

  1. In a web browser, run the installation script http://<YOUR_XCART_DOMAIN>/install-xaom.php replacing the variable <YOUR_XCART_DOMAIN> 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 .
  1. After the installation script removes the module files and deactivates the module, click the Next button to complete the uninstallation.
  2. At the Uninstallation complete screen, click the Next button to leave the Wizard.
Important: After you have uninstalled X-Affiliate, be sure to remove the module distribution package from your web directory.

Uninstalling X-Affiliate

Enabling and Configuring X-Affiliate

Improving User Experience

Managing Affiliate Programs

Managing Affiliate Partners

Creating Partner Accounts

Approving and Declining Partner Applications

Assigning Affiliate Plan to Partner

Managing Affiliate Plans and Commissions

Creating Affiliate Plans

Setting up Plan's Commission

Setting up Plan's Multi-tier Commission

Assigning Affiliate Plan to Partner

Handling Banners

Handling Generic Banners

Handling Specific Banners

Tracking Advertising Campaigns

Controlling Commission Payments

Managing Partner Accounts

Managing Partner Orders

Uploading Payment Info

Affiliate Statistics

Banners Statistics

Referred Sales Statistics

Top Performers Statistics

Multi-tier Affiliates Statistics

Advertising Campaigns Statistics