The 'Affiliates' add-on allows you to offer discounts and commissions to affiliates that wish to refer new members to your site. The OpenCrypt Affiliates system allows you to setup and track the amount of business generated by your referrers.
The Affiliates system has three methods for handling referrals: User Referrals, Affiliate Referrals and Coupons.
User Referrals allow you to offer discounts, credits or points to your existing users for referring new members to the site. These discounts or credits can then be used to discount their next renewal, or the points can be used for additional purchases.
Affiliate Referrals allow you to let affiliates sign up separately to your users (via the affiliate.cgi file, or added manually with the Affiliate User Configuration) and then discounts, credits or commissions can be applied to these affiliate accounts. e.g. Each affiliate could take a commission of 10% of the registration of a new member they have referred. Affiliates have their own account management system, the Affiliate Account Manager (affiliate.cgi).
Coupons allow you to specify discounts to new members during the registration process, which are deducted from the invoice shown during registration/purchase.
To allow referrals to be handled by the registration process, they must be passed as query strings to register.cgi, some examples are below:
From a User: the referring user should link to register.cgi with the following string - www.mysite.com/cgi-bin/oc/register.cgi?refu=MYUSER where MYUSER is their username.
From an Affiliate: the referring affiliate should link to register.cgi with the following string - www.mysite.com/cgi-bin/oc/register.cgi?refa=A000001 where A000001 is their affiliate account username.
To create a new referral type simply open the Main Configuration link, and then click the 'Create' button.
Type: allows you to define whether this is a User, Affiliate or Coupon referral.
Name: enter a meaningful name for the new referral configuration here.
Subscriptions: allows you to define which subscriptions this referral configuration applies to.
Products: allows you to define which products this referral configuration applies to.
Shopping Cart Product IDs: allows you to define discounts and commissions for specific Shopping Cart Product IDs, you can enter as many ID's as required, in the format product_id,discount,commission. Discounts and commissions can both be either percentages, or monetary amounts e.g. prod1,10,5% would give prod1 a discount of 10 to the person shopping, and a commission of 5% to the affiliate or user.
Discount: allows you to define a discount to be deducted from any membership setup fees, product fees, recurring fees and future charges. The discount is subtracted from the sub-total, before shipping and taxes are calculated. The discount is subtracted individually from each of any setup fees, recurring fees, and product fees you may have. This discount does not apply to shopping cart items, which must be configured as above.
Commission: allows you to define a commission amount to be credited to either User or Affiliate accounts for each referral. The commission does not apply to Shopping Cart items, which must be configured as above.
Points: allows you to apply points when the reffered member registers. For User referrals the points are applied to the referring users account. For Affiliate and Coupon referrals the points are applied to the new members account.
Coupon Codes: allows you to define the coupon codes that will apply to this referral, please enter one unique coupon code per line.
Subscription Upgrade: allows you to upgrade the new members subscription level automatically if they have been referred.
Default Affiliate Configuration: allows you to set whether this specific configuration will be applied to a new Affiliate if they register through the affiliate.cgi file, this should only be applied to ONE Affiliate referral configuration.
To create the new referral press the 'Submit' button once the above details are complete.
To modify an existing referral type either click the description of the referral, or select its radio button, and then press the 'Modify' button.
To remove an existing referral type select the radio button of the referral you wish to remove, and then press the 'Remove' button.
To create a new user simply open the User Configuration link, and then click the 'Create' button.
Affiliate Configuration: allows you to specify which configurations are available to this affiliate user.
Password: allows you to specify a password for this affiliate user.
Email Address: allows you to specify the e-mail address for this affiliate user.
First Name: allows you to specify the first name for this affiliate user.
Last Name: allows you to specify the last name for this affiliate user.
Organisation: allows you to specify any applicable organisation name for this affiliate user.
Address: allows you to enter the first and second lines of the mailing address for this affiliate user.
City: allows you to enter the city of the mailing address for this affiliate user.
State: allows you to enter the state of the mailing address for this affiliate user.
Postal Code: allows you to enter the ZIP or Postal Code for this affiliate user.
Country: allows you to enter the country for this affiliate user.
Telephone: allows you to enter the telephone details for this affiliate user.
URL: allows you enter the URL of the website for this affiliate user.
User Notes: allows you to enter notes to be displayed to the user during signup, for example payment information.
Admin User Notes: allows you to leave notes for yourself and other administrators for this affiliate account.
To modify an existing Affiliate User account either click the username for the account, or select its radio button, and then press the 'Modify' button.
To remove an existing Affiliate User account select the radio button of the account you wish to remove, and then press the 'Remove' button.
The statistics view allows you to see details of all the commissions and discounts that have been applied to Affiliate or User accounts
To view or modify a referrer record simply click the account you wish to view under the Referrer heading.
To view or modify the details of a referred user simply click the username required under the Referred User heading.
To mark any due commission to an Affiliate as paid, open their account record from the User Configuration or Statistics sections. A total of all commission due will be displayed with the option to mark as paid next to the commission total.
In the affiliate.cgi management panel, there is a link to the campaigns which contain details of the link that each affiliate should use to refer traffic to your site. This is customisable so that you can provide your affiliates with example banners etc. To customise this screen, edit the generate_affiliate_link.php file which can be found in your main OpenCrypt directory.