Manual for version 3.05
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Content 1 Installation 1.1 Edit settings.php 1.1.1 The database 1.1.2 Exchange information 1.1.3 The banner exchange 1.1.4 The pop-under exchange 1.1.5 Expiration date 1.1.6 Frame options 1.1.7 Paypal options 1.1.8 Cheater functions 1.2 Run setup.php 1.3 Edit the layout 1.4 Emails 1.5 The language file 2 Upgrade from an older version 3 The layout 3.1 header.php 3.2 footer.php 3.3 style.css 4 The admin area 4.1 Approving sites 4.1.1 Sites with other pop-unders 4.1.2 Default sites 4.1.3 Site priority 4.2 View active sites 4.2.1 Edit a site 4.2.1.1 Raw banner HTML 4.3 Default sites 4.3.1 The zero site 4.4 View all users 4.4.1 Edit a user 4.5 View categories 4.5.1 The zero category 4.5.2 Category statistics 4.5.3 Category type 4.5.4 Public and private categories 4.5.5 The "Under Investigation" category 4.6 View log 4.7 Send mail 4.8 Network Stats 4.9 Partnerships 4.9.1 Setting up a partnership 4.9.2 Cancel a partnership 4.9.3 Category targetting 4.10 Cheaters 4.10.1 Under Investigation 5 The member area 5.1 All sites 5.2 Edit a site 5.3 Add another site 5.4 Removing a site 5.5 Purchasing credits 6 Selling ad space 6.1 Edit settings.php 6.1.1 Selling pop-unders 6.1.2 Selling banners 6.1.3 Accepting PayPal 6.1.4 Accepting e-Bullion 6.1.5 Accepting e-Gold 6.1.6 Accepting NetPay 6.1.7 Accepting ClickBank / Credit Cards 6.2 Creating your own payment module 7 More help Appendix A File structure Appendix B Error IDs If you're using another version of the pop-under exchange script this manual can still be helpfull, but some of the functions may not work as described (see 2 Upgrade from an older version). This manual can be downloaded here for free. First you need to download the script from the Xavier Media Group website. Then you need to unzip the file (called something like popunder_XX.zip). If you don't have a program to unzip files you can get one at WinZip.com. Locate a file called /includes/settings.php and open it with a text editor like WordPad. Change $mySQL_host, $mySQL_user, $mySQL_pwd so that they match the database login information your web host gave you when you signed up. If you don't have them you have to contact your web host, not us. Set $DataBase to the name of the database you're going to use. The script can create a new database for you, but if you're going to use an existing database you need to set $DataBase to this name.
Set $ExchangeSite to the URL where the script is located (no / at the end), $ExchangeName to the name of your exchange and $ExchangeEmail to your email address. Please don't use our email address as $ExchangeEmail, because we will not answer your users questions for you. $AdminLogin and $AdminPwd are the login name and password you will use to access admin.php (see 4 The admin area). If you set $ContactNewSite to Y, then the script will send you a mail every time someone edit or add a new site. Set it to N if you don't want any emails. If you change anything of the above after you have installed the script you don't have to run setup.php again. Just upload settings.php. To use the banner exchange you have to set $UseBannerExchange to Y, otherwise the banner exchange will be turned off and you will only have the pop-under exchange. $BannerDefaultRatio is the default exchange ratio for banners. 0.5 means that for every 2 banners the user show he will earn one credit, 0.75 means that for every 4 banners the user show he will earn 3 credits. The exchange ratio can also be changed for each user at the admin area (see 4.4.1 Edit a user). $BannerReferRatio is the referral ratio, i.e. the number of credits the referring user will get for every banner shown by the referred user. If you set this to 0.1 the reffering user will get 0.1 credits for every banner the referred user show. If you set $IncludeRefHTML to 1 the link to your exchange below the banner will include a referral code for your users. $BannerBonusCredits and $BannerReferBonusCredits are the number of bonus credits you would like to give your new users respectively the user who referred the new user. If you would like to give your users a bonus every time someone clicks on a banner on their site you can set $BannerClickCredits to the number of credits you will give your users. $BannerReferCredits is the same thing, but for the referring user. If you change anything of the above after you have installed the script you don't have to run setup.php again. Just upload settings.php. $PopUnderDefaultRatio is the default pop-under exchange ratio. 0.5 means that for every 2 pop-unders the user show he will earn one credit, 0.75 means that for every 4 pop-unders the user show he will earn 3 credits. The exchange ratio can also be changed for each user at the admin area (see 4.4.1 Edit a user). $PopUnderReferRatio is the referral ratio, i.e. the number of credits the referring user will get for every pop-under shown by the referred user. If you set this to 0.1 the reffering user will get 0.1 credits for every pop-under the referred user show. Set $PopUnderBonusCredits to a value greater than 0 if you would like to give your new users a sign-up bonus. $PopUnderReferBonusCredits is the smae thing but for the referring user. If you $SiteNotFoundPopUnder to 1, then the URL in $SiteNotFoundURL will pop-under if the user site can't be found in the database, i.e. if the site has been deleted by you or the user himself. If you change anything of the above after you have installed the script you don't have to run setup.php again. Just upload settings.php. $SiteExpDate this is how often a site must display a banner or pop-under to be in the rotation. At default it is set to 7 days. This is great if you have a large number of sites signing up just for the sign-up bonus, but never use your HTML code. Have you seen for example the top frame Exit Exchange are using on every pop-up? You can have the same thing in your exchange, just change $FrameWindow to 1, $FrameWindowSize to the size of the topframe and $FrameWindowURL to the URL of your frame. In the zip-file a sample top frame is included, but you can use any top frame you like. The following variables can be used in the top frame:
If you instead of a top frame would like a splash screen (that's a page that is shown to the user for about 2 seconds before the member site show up), then set $FrameWindow to 2. Change $SplashTime to the number of seconds before the user is redirected to the member site and $SplashLogo to the URL of your logo. See 6. Selling ad space below. They should actually be called anti-cheater functions, because they find sites trying to cheat and report them to you on a special page in the admin area (see 4.10 Cheater functions). In settings.php you can turn this function off by setting $UseCheaterFunctions to 0. You can also change how sensitive the script will be by increasing $CheaterNumber (the higher number the less sensitive the script will be). IT's not recommended to set the value below 3. The cheater functions can't be used if you have MySQL server version below 3.23.54. Upload all your files to your web server and visit /install/setup.php with your web browser. Enter your Ticket number in the input field and click on Continue with setup. The ticket number is the number you received from ClickBank when you purchased the script. If you paid by PayPal you received the ticket number from Xavier Media Group, in other words it's NOT your PayPal transaction id. Click continue until the setup is completed (don't forget to print the final page for future reference). The last thing you should do is to delete setup.php and upgrade.php. Starting with version 3.00 beta the admin area can't be accessed if setup.php and upgrade.php are still on your server. Now visit the admin area and start playing around with your new exchange (see 4 The admin area). See 3 The layout below. All confirmation emails are plain text files located in /mail/. You can edit them as you like:
Feel free to change the text files above to anything you like, but you shouldn't delete or rename them. A few tags can be used in the emails:
If you would like to translate your exchange to another language you can easily do so by editing /includes/language.php. 2 Upgrade from an older version If you have an older version of the pop-under exchange script you can use upgrade.php to upgrade to the current version. This only works if you have version 2.0 or better, because the changes from version 1.5 to 2.0 was too complicated and too many. Open settings.php in a text editor and change the variables so that the exchange works the way you want. For more information about the diffrent variables and options available, please read 1.1.1 The database, 1.1.2 Exchange information, 1.1.3 The banner exchange, 1.1.4 The pop-under exchange, 1.1.5 Expiration date, 1.1.6 Frame options and 1.1.7 Paypal options. Upload all files, except for header.php, footer.php and style.css, to your web server and visit upgrade.php with your web browser. If you're upgrading from version 2.X to 3.0 or better you need to upload header.php and footer.php also because of changes in the file structure (see Appendix A File Structure). Select the version your upgrading from and wait a few seconds. Now visit the admin area and start playing around with your upgraded exchange (see 4 The admin area). You can change the layout of your exchange by changing /includes/header.php, /includes/footer.php and style.css. header.php contain the upper part of your pages. In here you can change for example the title of your exchange or the background colors. It can be wise to create a new page and include for example ///////// where you want the script generated content to be inserted, then copy everything above ///////// into header.php and everything below into footer.php. In footer.php you'll find everything that's included under the script generated content. See also 3.1 header.php above. You don't have to use style.css if you don't want to, but in this file you can change for example the text size, the look of input fields and link colors. From admin.php you can delete sites/users, change exchange ratios and much much more. To access the admin area you need the login name and password you selected in settings.php (see 1.1.2 Exchange information above). This is the first page you will see when you access the admin area. If you have a site waiting for your approval you will see the site information, otherwise you will just see No sites to approve!. If you have a site waiting for your approval you can scroll down and see all inormation about that site. If you deside to approve the site you just select Yes at Approve this site?. If you select No the site will be rejected and a mail will be sent to the user (see 1.4 Emails). In the box below you can enter your reasons for rejecting the site. If you like the site but don't like the banner you can select No at Approve banner:. That will approve the site for pop-under rotation, but reject the banner for banner rotation. Two emails will then be sent to the user, one telling him that the site has been accepted and another telling him that the banner was rejected (see 1.4 Emails). As for approving the site you can enter your reasons for rejecting the banner in the box called Banner fail reasons: . If the user hasn't entered any banner URL when he signed up you will notice that No banner is checked, that's almost same thing as No but no email will be sent to the user. 4.1.1 Sites with other pop-unders If a site has many other pop-unders, pop-ups and java promts you can select Yes at Do this site have other pop-ups/pop-unders or java prompts?. That will display a server generated page with a link to the member site. That way the visitor will not get 1,000 of pop-ups from your exchange and the site can still be a member. By selecting Yes at Is this site a default site? the site will become a default site, i.e. it will show up when no other sites are available. If the site has more that 0.99 credits it will be included in rotation even if there are other sites available. The priority of the site is measured by numbers (1-5). 5 is the lowest priority a site can have and 1 is the highest. A site with priority 1 will be shown 5 time more often than a site with priority 5. At default all sites have priority 3. At this page you will see a list of all active sites in the exchange, i.e. all site you have approved. Sites that have an approved URL but a rejected banner will also show up in this list. By clicking on the name of the site you will get to a page with all site information (see 4.2.1 Edit a site). If you belive that a site is cheating somehow, you can click on View log and see the most resent banners and pop-unders for that site. This page can be found by clicking on the site name anywhere in the admin area. Here you can edit all information about the site, find out who the owner is and give the site banner or pop-under credits. This is raw HTML code that will be used instead of the banner entered at Banenr URL. Click tracking can't be provided for raw HTML banners, and only the admin can change the banner (not the user). A raw HTML banner can look like this:
Default sites is same thing as View active sites, but only sites that have been selected as default sites will be included in the list. This is the first site in your exchange and it has site id (SID) 0. It can't be deleted and it will always be default site even if you change it. You can edit this site in the same way you edit all other sites (see 4.2.1 Edit a site). At this page you'll find a list of all users in your exchange. By clicking on Delete the user and all sites owned by him wil be removed from your exchange. Be carefull because this process can't be reversed. You can also add a new user and a new site at this page. The site and the banner you enter at this form will be automaticly approved (that's because you're entering the information yourself). By clicking on a users name at the View all users-page you will be taken to a new page where you can edit the user. You can also click on View account owner at the Edit a site-page (see 4.2.1 Edit a site). At this page you can change the exchange ratio for this user and add or remove sites. All sites you add will be approved automaticly. At View categories you'll find a list of all categories in the exchange. If you have only one category the users will not be able to select a category when they join or add a new site, but if you have more than one category they will be able to do that. The first category, also called "the zero category", (see 4.5.1 The zero category) will not show up as an selection to your users. That's because sites in that category will show up on any site in any category in your exchange. To add a new category, just enter the name in the box and press "Save". If you delete a category, all users in that category will be moved to "the zero category". This is the first category in the exchange and it can't be deleted. You can however rename it to anything you like. If you have more than one category, this category will not be included in the category list presented to the user. In other words it can only be selected by the admin. Sites in this category will show up on any site in any category in your exchange. By clicking on Stats you will be taken to a page similar to Network Stats (see 4.8 Network Stats). This page will display the daily number of pop-under and banner views in graphs. Starting with version 2.6 beta partnerships between diffrent exchanges was made possible (see 4.9 Partnerships). If you don't have any partnerships then you don't have to worry about the category type, otherwise this is used so that the other exchange will know what kind of sites it can expect in your categories. 4.5.4 Public and private categories You can have both public and private categories in your exchange. Public categories are categories that can be selected by the user when he join your exchange or in the members area, and private categories are categories that can only be selected by the admin. This way you can set-up a category called, for example, Friends. In this category you only have sites owned by your friends. No other users can select this category and only your friends sites will be in it. This makes it possible to create special categories for good and trusted sites, your friends or your own websites. 4.5.5 The "Under Investigation" category See 4.10.1 Under Investigation. This is a page where you can see the most resent pop-unders and banners in your exchange. Just click on the site name and you will be taken to a page where you can see all information about that site. At this page you can send email to your users. In the message box you can use tags like %PASSWORD%, %EMAIL% and %NAME%. The tags will be replaced with information about the user from the database. Here you can view figures with the daily number of pop-unders, banners and clicks on banners. If you have Internet Explorer you can hold your mouse pointer over the figure you will be able to see the date and the number of views/clicks. In the category section you'll find a similar page with information for each category you have (see also 4.5.2 Category Statistics). Starting with version 2.6 beta you can team up with another exchagne and help each other grow. By setting up a partnership with another exchange you will exchange pop-under views (not banners at the moment) with the other exchange if you don't have any pop-unders to display. That way you don't have to display so many default pop-unders if you have few sites in a category. 4.9.1 Setting up a partnership The first thing you should do is to contact the admin at the other exchange and ask if it's OK to set-up a partnership. Then visit your admin area and click on Partners and then Add Partner. When you have set-up a partnership you can only wait until the other exchange approve you. You can view the status of your partnerships at the partnership page. You can at any time visit the partnership page and cancel a partnership. All you have to do is click on the Cancel partnership link next to your partner. The other exchange will be informed that you cancelled the partnership. To make the category targeting work with a partnership, you need to select a type for your categories so that the other exchange know how to find similar sites. You can select between the following types for your categories: For example a site in a category with category type Casino & Gambling will not show up on a site in a category with type Kids & Teens. Starting with version 3.0 the exchagne script will report users that may be cheating. You always review each individual case, because the script can be wrong sometimes. The sites the script belive is cheating will be listed in the admin area under "Cheaters". Sometimes the script will also move the site to a new category "Under Investigation" (see Under Investigation). In settings.php you can turn this function off by setting $UseCheaterFunctions to 0. You can also change how sensitive the script will be by increasing $CheaterNumber. The cheater functions can't be used if you have MySQL server version below 3.23.54. If the script find too much suspicious activity it will move the site to a new category called "Under Investigation". Sites in this category can't change category (only the admin can) and they will only display default banners (see Default Sites). If the site is no guilty the you can move it to another category (you shold move it from "Under Investigation" if it's innocent). This is the page where your users can add, change and remove sites from the exchange. When the user login at the member area he will see a list of all his sites an the status of them. By clicking on the sites name or on Banner HTML code he will be taken to a page where he can edit the site. The user can edit all information about his site except exchange ratio, credits, status and raw banner HTML. Every time a user change something the site will be removed from rotation until the admin approve the changes (see 4.1 Approving sites). If $ContactNewSite is set to Y a mail will be sent to the email address provided in settings.php (see 1.1.2 Exchange information). A user can have multiple sites in one account. All he has to do is fill out the form at the bottom of the All sites-page. The user will be able to add the HTML code at the site and start earning credits at once, but the site will not be included in rotation until the admin has approved the site (see 4.1 Approving sites). Only "the zero site" (see 4.3.1 The zero site) will be shown on sites that are not approved yet. A user can delete all his sites except for the first one. That site can only be removed by admin. By clicking on Delete at the member area the site wil be permanently removed. If $SellCredits has been set to 1 the user will be able to buy credits by clicking on Buy at the member area (see 6 Selling ad space). It's easy to sell ad space with the pop-under exchange script. All you have to do is edit settings.php and wait for someone to buy from you. The script will confirm the purchase and add credits to the users account. Open settings.php with a text editor, for example WordPad, and locate CREDIT SELLING OPTIONS at the end of the file. Change $SellCredits to 1 and $UseCurrency to the currency you would like to use. Please remember that not all currencies can be used with all payment options:
You can use all or only one of the above payment options, but please remember that you can't use for example NetPay, e-Bullion and ClickBank if you set $UseCurrency to EUR. The user will be able to purchase credits by clicking on Buy at the member area (see 5 The member area). Edit $popunderamount and $popunderprice so that they contain the amount of pop-unders you would like to sell and the price the user should pay. You can add as many lines in $popunderamount and $popunderprice as you like:
Make sure that you have the same number of lines in both $popunderamount and $popunderprice. Edit $banneramount and $bannerprice so that they contain the amount of pop-unders you would like to sell and the price the user should pay. You can add as many lines in $banneramount and $bannerprice as you like:
Make sure that you have the same number of lines in both $banneramount and $bannerprice. The user will, of course, not be able to buy banner credits if you have turned off the banner exchange (see 1.1.3 The banner exchange). To accept PayPal you change $UsePayPal to 1 and $PayPalEmail to your PayPal email address. To accept e-Bullion you change $UseeBullion to 1 and $eBullionAccount to your e-Bullion account number. To accept e-Gold you change $UseeGold to 1 and $eGoldAccount to your e-Gold account number. To accept NetPay you change $UseNetPay to 1 and $NetPayAccount to your NetPay account number. 6.1.7 Accepting ClickBank/Credit Cards To accept ClickBank you change $UseClickBank to 1 and set-up one URL with ClickBank for each amount you are going to charge. For example if you charge $10.00 for 1,000 popunders and $10.00 for 5,000 banner impressions you only need one URL. If you are going to charge $10.00 for 1,000 popunders and $2 for 1,000 banner impression then you need two URLs:
All Thank-you Pages should be set to http://www.yoursite.com/path_to_the_popunder_exchange/scripts/clickbank.php. 6.2 Creating your own payment module If you create your own payment module you can accept any payment method you like and not just the 5 already included. This chapter will briefly describe how to create your own module, but please remember that Xavier Media Group can not give you support for this. To be able to use a payment system it must be able to send variables to a script on your server as a status URL or a "Thank-You" page. The variables that are important are $sid (the site ID), $amount (the number of credits purchased) and $type (banners or popunders). Open members.php and locate:
In your button you can use $sid (the Site ID), $popunderamount[$i] (the amount of popunders ordered), $banneramount[$i] (the number of baners ordered), $popunderprice[$i] (the price for the selected quantity of pop-unders), $bannerprice[$i] (the price for the selected quantity of banners). When you have inserted you payment button you need to write a payment module. If your payment service can send variables to a status URL, you can use module_status.php, if not use module_url.php. Uncomment the second line with settings.php and make any changes you need to make the script work. If your payment system can't send the variables $sid, $amount and $type with those names you need to translate the varialbes so that the script will understand them:
If you use status URL, then you should redirect your users to members.php directly and not to module_status.php. If you are not using status URL, then you should redirect your users to module_url.php togother with the variables. Good Luck! If you have questions that can't be answered by reading this manual, you're more than welcome to ask your questions in our discussion forum. |
All rights reserved.