Difference between revisions of "NATS4 Affiliates Admin"

From TMM Wiki
Jump to navigationJump to search
 
(29 intermediate revisions by 4 users not shown)
Line 3: Line 3:
 
}}
 
}}
  
−
The Affiliates Admin is a feature in [[NATS4]] that allows you to manage your affiliates, view their statistics, edit their permissions and details, and get other essential information.
+
The Affiliates Admin is a group of features in [[NATS4]] that allow you to manage your affiliates, view their statistics, edit their permissions and details, and get other essential information.
  
−
[[File:Affiliates-admin.png|450 px|Affiliates Admin]]
+
[[File:AffiliateAdmin-41.png|650 px|The NATS4 Affiliates Admin]]
  
−
The top search box lets you find specific affiliates by using multiple search parameters, including username, full name, e-mail, NATS ID, country, and other. Once you have found the affiliates you were searching for, you can perform a variety of functions. You can select and edit multiple members at once by using the checkboxes to the left of each Affiliate. Once you have selected the affiliates you wish to edit, scroll to the bottom of the page and use the Perform Action drop-down menu to change multiple affiliates. Also to the left of the affiliate will be the Edit Affiliate Account Access Permissions icon. To change affiliate account permissions, click the icon displayed. For more information about affiliate access permissions, see the Access Permissions section below.
+
== Searching For Affiliates ==
  
−
[[File:Affiliate-permissions.png|450 px|Edit Affiliate Permissions]]
+
At the top of the Affiliates Admin main page, you will see an "Affiliate Search" box, which allows you to find specific affiliates by using a variety of search parameters. As of [[NATS]] version 4.0.74.1, the Affiliates Admin now offers Basic and Advanced search forms. The basic form allows you to search by Username, E-Mail, Affiliate ID, and Status (active, banned, disabled, etc.). The Advanced Search Form offers a wide variety of parameters to search by, allowing you to make more specific search parameters. These categories include:
  
−
To the right of each affiliate are several action icons, which allow you to perform certain tasks involving your affiliates.
+
* '''Account Info''' - Search by basic affiliate information, such as username, e-mail, real name, ICQ, AIM, address, etc.
 +
* '''Linked Accounts''' - Search by referring affiliate, referrer ID, and account rep.
 +
* '''Payment Details''' - Search by minimum payout, [[Pay Via Types|PayVia type]], or PayVia info.
 +
* '''Statistics for (period)''' - Sort statistics by time periods, such as last period, this period, this year, etc. Search by raw hits, unique hits, join hits, join submits, joins, and ratio. You can specify your search by "Less Than" or "At Least".
 +
* '''Access Details''' - Search by join IP, join date, last login IP, and last login date.
 +
* '''Limitations''' - Only search for specific account type, whether an account is in-house, and choose how many affiliates to display per page.
 +
 
 +
[[File:Advanced-Affiliate-Search-41.png|450px|NATS4 Advanced Affiliate Search]]
 +
 
 +
You can also get a complete CSV Dump of affiliate data by clicking the "Full CSV Dump" button in the Affiliate Search box at the top of the page. As of version 4.0.74.1, [[NATS4]] also offers an "E-mail Dump" feature. This will obtain only dumps of affiliates' e-mail addresses, an additional dump statistic, through the affiliate search table.
 +
 
 +
== The Affiliates Table ==
 +
 
 +
The Affiliates Table can be found below the "Affiliate Search" box on the Affiliates Admin main page. This contains information regarding every affiliate you have in your [[NATS]] system, including:
 +
 
 +
* '''Username''' - Displays the username of the affiliate, and the status of their account (active, disabled, banned)
 +
* '''Real Name (Country)/E-Mail''' - Displays the real name of the affiliate, along with their country and the e-mail address they used to register
 +
* '''Joined/Last Login''' - Displays the time and date the member joined, as well as their last login
 +
 
 +
[[File:Affiliates table.PNG|450px|The NATS Affiliates Table]]
  
−
* The ''Affiliate Overview'' Icon shows the affiliate's account information
+
At the bottom of the Affiliates Table, you will find a drop-down menu that allows you to perform batch actions on affiliates. You can perform these batch actions by selecting them with the checkboxes to the left of each affiliate name, and using the available drop-down menu. Through the drop-down menu, you can:
−
* The ''Override'' icon lets you overrides as that affiliate. For more details, see the Override section below
 
−
* The ''Edit Affiliate Details'' icon lets you change the affiliate's account details page
 
−
* The ''Affiliate Statistics'' icon takes you to the affiliate's statistics page
 
−
* The ''Affiliate Documents'' icon lets you upload documents for affiliates.  For more information, see the Affiliate Documents section below.
 
−
* The ''Add Manual Sale'' icon adds a manual sale.  For more details, see the Manual Sale section below
 
−
* The ''Add Manual Invoice'' icon adds a manual invoice. For more details, see the [[NATS4 Manual Invoice|Manual Invoice article]]
 
−
* The ''Edit Affiliate Admin Settings'' icon lets you change several special settings.  For more details, see the Affiliate Admin Settings section below
 
−
* The ''Change Affiliate Password'' icon changes the affiliate's password
 
−
* The ''Change Affiliate Status'' icon lets you Disable or Ban affiliates.  For more details, see the Disabling and Banning Affiliates section below
 
−
* The ''Delete Affiliate'' icon deletes the affiliate's account
 
  
−
Note: NATS automatically hides icons that can't be used by certain affiliates.
+
* '''Delete''' - Removes the selected affiliates from list of available affiliates.
 +
* '''Restore (Delete)''' - Restores a deleted affiliate to your "Affiliates" list. This functionality will be added to later versions of [[NATS4]].
 +
* '''Remove Account Rep''' - Removes the selected affiliate(s) from their current [[NATS4_Account_Representatives|account representative]].
 +
* '''Assign Account Rep''' - Allows you to assign an [[NATS4_Account_Representatives|Account Representative]] to a chosen affiliate. This action cannot be performed as a batch action.
 +
* '''Assign Referrer''' - Allows you to assign an affiliate as a referrer for another affiliate. This action cannot be performed as a batch action.
  
−
== Affiliate Admin Settings ==
+
Click the Perform Action button to perform your specified action to your selected [[Ct#Affiliate|affiliates]].
  
−
Affiliate Admin Settings allows you to customize affiliates beyond the standard settings. Here you can manually mark In-House Accounts, indicate that certain documents have been received, set trust levels, and allow features like instant payments and manual invoices.
+
You can also perform various actions to individual members by using the available Action Icons, detailed below.
  
−
* The Manual Invoice checkbox enables the Manual Invoice icon described above.  For more details, see the [[NATS4 Manual Invoice|Manual Invoice article]]
+
== Affiliate Action Icons ==
  
−
You also have the option to use optional settings and flags, which can be customized to suit your needs.
+
To the right of each affiliate are several action icons, which allow you to perform certain tasks involving your affiliates.
  
−
== Overriding Affiliates ==
+
* The '''Affiliate Overview''' Icon shows the affiliate's account information
 +
* The '''[[NATS4 Affiliate Override|Override]]''' icon lets you overrides as that affiliate.  For more details, please see our [[NATS4 Affiliate Override]] wiki article.
 +
* The '''Edit Affiliate Details''' icon lets you change the affiliate's account details page. This will override as the specified affiliate.
 +
* The '''Affiliate Statistics''' icon takes you to the affiliate's statistics page. This will override as the specified affiliate.
 +
* The '''Affiliate Documents''' icon lets you upload documents for affiliates.  For more information, see the Affiliate Documents section below.
 +
* The '''[[Add Manual Sale]]''' icon adds a manual sale.  For more details, please see our [[Add Manual Sale]] wiki article.
 +
* The '''Add Manual Invoice''' icon adds a manual invoice.  For more details, see the [[NATS4 Manual Invoice|Manual Invoice article]]
 +
* The '''[[NATS4 Affiliate Admin Settings|Edit Affiliate Admin Settings]]''' icon lets you change several special settings.  For more details, see our [[NATS4 Affiliate Admin Settings]] wiki article.
 +
* The '''Change Affiliate Password''' icon changes the affiliate's password
 +
* The '''[[Change Affiliate Status]]''' icon lets you Disable or Ban affiliates. For more information, please see our [[Change Affiliate Status]] wiki article.
 +
* The '''Change API Key''' icon changes the API key for the specified affiliate. For more information on API keys, please see our [[NATS4 API]] wiki article.
 +
* The '''Delete Affiliate''' icon deletes the affiliate's account
  
−
An override is an [[Common Terms#Admin (NATS)|admin's]] ability to temporarily take over an existing [[Common Terms#Affiliate|affiliate]] account in order to view and edit certain settings. Overriding as an affiliate will not affect the administration interface, but any changes made in the affiliate area change the affiliate's account.
+
Note: NATS automatically hides icons that can't be used by certain affiliates.
  
−
== Access Permissions ==
+
== Affiliate Access Permissions ==
  
 
To edit affiliate access permissions, click the icon to the left of their account name. The Account Type drop-down menu on this page has six options ordered from least access to most access:
 
To edit affiliate access permissions, click the icon to the left of their account name. The Account Type drop-down menu on this page has six options ordered from least access to most access:
Line 49: Line 73:
 
* A TMMAdmin has full administrative access, but can only log in from the IP addresses specified by the TMM_ADMIN_IPS configuration option.  For more information, please see the [[NATS4 Configuration Options|Configuration Options article]]
 
* A TMMAdmin has full administrative access, but can only log in from the IP addresses specified by the TMM_ADMIN_IPS configuration option.  For more information, please see the [[NATS4 Configuration Options|Configuration Options article]]
 
* An Admin has full administrative access.  For more information, see the [[NATS4 Creating Admin Accounts|Admin Accounts article]]
 
* An Admin has full administrative access.  For more information, see the [[NATS4 Creating Admin Accounts|Admin Accounts article]]
 +
 +
For more information on the Affiliate Access Permissions feature, please see our [[NATS4 Affiliate Access Permissions]] wiki article.
  
 
== Affiliate Documents ==
 
== Affiliate Documents ==
  
 
NATS lets you upload and send documents to [[ct#Affiliate|affiliates]]. To do so, go to the [[Affiliates Admin]], select the affiliate you want, and click the Affiliate Documents icon. Once you are on the Documents page, you can use the field there to upload and send documents to this affiliate-- existing documents will be listed on the page.
 
NATS lets you upload and send documents to [[ct#Affiliate|affiliates]]. To do so, go to the [[Affiliates Admin]], select the affiliate you want, and click the Affiliate Documents icon. Once you are on the Documents page, you can use the field there to upload and send documents to this affiliate-- existing documents will be listed on the page.
 +
 +
[[File:Affiliates-Documents-41.png|450px|Uploading Documents in NATS]]
 +
 +
Before you can begin uploading documents for your [[Ct#Affiliate|affiliates]], you must first make allowances for file extensions and IPs in the [[NATS4 Configuration Admin|Configuration Admin]]. Go to the "Security" section of the [[NATS4 Configuration Admin|Configuration Admin]] and scroll down to the "Document Upload" settings. Here, you will find two configuration settings regarding document uploads:
 +
* '''DOCUMENTS_SECURE_EXT''' - Input what file extensions you wish to allow in a comma-separated list. For example: .doc,.txt,.docx
 +
* '''DOCUMENTS_SECURE_IPS''' - Input what IPs will be allowed to upload documents in a comma-separated list.
  
 
=== Example Documents ===
 
=== Example Documents ===
Line 59: Line 91:
 
* Uploading an image of documents pertaining to instant payments
 
* Uploading an image of documents pertaining to instant payments
  
−
== Manual Invoices ==
+
== Affiliate Admin Settings ==
  
−
[[NATS]] allows you to give a one-time credit to an affiliate with a manual invoice. With this option, the affiliate will be paid the additional amount the next time you store payments.  
+
Affiliate Admin Settings allows you to customize affiliates beyond the standard settings. Here you can manually mark In-House Accounts, indicate that certain documents have been received, set trust levels, and allow features like instant payments and manual invoices.
  
−
'''Warning: after you make a manual invoice, you can not remove it; you must pay the affiliate.'''
+
For more information on Affiliate Admin Settings, please see our [[NATS4 Affiliate Admin Settings]] wiki article.
  
−
To add a manual invoice, go to Affiliate Admin, find the affiliate, and click the Edit Affiliate Admin Information icon. Enable the Manual Invoices check-box and click Save Changes.
+
When you are done further configuring your [[Ct#Affiliate|affiliate]], click Save Changes.
  
−
Once you have done this, return to the main Affiliate Admin, find the affiliate again, and click the new Add Manual Invoice icon.  Enter the amount to pay the affiliate and click Add Invoice.
+
== Manual Invoices ==
  
−
== Manual Sale ==
+
NATS allows you to give a one-time credit to an affiliate with a manual invoice. With this option, the affiliate will be paid the additional amount the next time you store payments.
  
−
To manually add a sale to an affiliate, go to the Affiliate's Admin, find the affiliate, and click the Add Manual Sale icon. Enter the manual sale details and click Add Manual Sale.
+
'''Warning: after you make a manual invoice, you can not remove it; you must pay the affiliate.'''
−
 
 
−
'''Warning: you cannot remove a manual sale -- it's a real sale, and you must pay the affiliate for it.'''
 
−
 
 
−
== Disabling and Banning Affiliates ==
 
−
 
 
−
A banned affiliate will not be able to login, and all of their traffic is redirected to /spam.html on your linkdomain. Once an affiliate is banned, they are automatically removed from the Payment Admin.
 
−
 
 
−
Although a disabled affiliate will not be able to login and will also be removed from the Payment Admin, their traffic will still be tracked by [[NATS]].
 
−
 
 
−
== Affiliate Start Page ==
 
−
 
 
−
If you want to store a particular start page for an affiliate or administrator, edit the template "members_header" with the following code:
 
  
−
{if $is_startpage}Your Startpage{else}<a href="internal.php">Startpage</a>{/if}
+
To add a manual invoice, you must first enable them in the Affiliates Admin. Find the affiliate you wish to allow manual invoices for, and click the Edit Affiliate Admin Settings icon.
 +
Under "Main Settings", enable the Manual Invoices check-box and click Save Changes.
 +
<br>[[File:admin_actions.png]]
 +
<br>Once you have done this, return to the main Affiliate Admin, find the affiliate again, and click the new Add Manual Invoice icon.
  
 +
<br>[[File:admin_actions_invoices.png]]<br>
  
 +
Enter the amount to pay the affiliate and click Add Invoice.
 +
<br>[[File:manual_invoices_table.png]]<br>
  
 
[[Category:NATS4 Administrator Guide]]
 
[[Category:NATS4 Administrator Guide]]
 +
[[Category:NATS4 Affiliates Admin]]

Latest revision as of 23:44, 20 February 2018

NATS 4
Affiliates Admin
The Affiliates Admin
ID Numbers
Account Representatives
Affiliate Referrals
Affiliate Activation
Affiliate Access Permissions
Affiliate Admin Settings
Affiliate Overrides
Creating Admin Accounts
In-House Accounts
Affiliate-Specific Join Options and Payouts
Add Manual Sale
Manual Invoices
Affiliate Groups
Affiliate Documents
Change Affiliate Status
Members Admin
The Members Admin
View Member Details
Add Member
MySQL Auth
Mod Authn DB
Multisite Access
Member Logging
Member Password Retrieval
OpenID Connect
Mod Auth OpenIDC
ID Numbers

The Affiliates Admin is a group of features in NATS4 that allow you to manage your affiliates, view their statistics, edit their permissions and details, and get other essential information.

The NATS4 Affiliates Admin

Searching For Affiliates

At the top of the Affiliates Admin main page, you will see an "Affiliate Search" box, which allows you to find specific affiliates by using a variety of search parameters. As of NATS version 4.0.74.1, the Affiliates Admin now offers Basic and Advanced search forms. The basic form allows you to search by Username, E-Mail, Affiliate ID, and Status (active, banned, disabled, etc.). The Advanced Search Form offers a wide variety of parameters to search by, allowing you to make more specific search parameters. These categories include:

  • Account Info - Search by basic affiliate information, such as username, e-mail, real name, ICQ, AIM, address, etc.
  • Linked Accounts - Search by referring affiliate, referrer ID, and account rep.
  • Payment Details - Search by minimum payout, PayVia type, or PayVia info.
  • Statistics for (period) - Sort statistics by time periods, such as last period, this period, this year, etc. Search by raw hits, unique hits, join hits, join submits, joins, and ratio. You can specify your search by "Less Than" or "At Least".
  • Access Details - Search by join IP, join date, last login IP, and last login date.
  • Limitations - Only search for specific account type, whether an account is in-house, and choose how many affiliates to display per page.

NATS4 Advanced Affiliate Search

You can also get a complete CSV Dump of affiliate data by clicking the "Full CSV Dump" button in the Affiliate Search box at the top of the page. As of version 4.0.74.1, NATS4 also offers an "E-mail Dump" feature. This will obtain only dumps of affiliates' e-mail addresses, an additional dump statistic, through the affiliate search table.

The Affiliates Table

The Affiliates Table can be found below the "Affiliate Search" box on the Affiliates Admin main page. This contains information regarding every affiliate you have in your NATS system, including:

  • Username - Displays the username of the affiliate, and the status of their account (active, disabled, banned)
  • Real Name (Country)/E-Mail - Displays the real name of the affiliate, along with their country and the e-mail address they used to register
  • Joined/Last Login - Displays the time and date the member joined, as well as their last login

The NATS Affiliates Table

At the bottom of the Affiliates Table, you will find a drop-down menu that allows you to perform batch actions on affiliates. You can perform these batch actions by selecting them with the checkboxes to the left of each affiliate name, and using the available drop-down menu. Through the drop-down menu, you can:

  • Delete - Removes the selected affiliates from list of available affiliates.
  • Restore (Delete) - Restores a deleted affiliate to your "Affiliates" list. This functionality will be added to later versions of NATS4.
  • Remove Account Rep - Removes the selected affiliate(s) from their current account representative.
  • Assign Account Rep - Allows you to assign an Account Representative to a chosen affiliate. This action cannot be performed as a batch action.
  • Assign Referrer - Allows you to assign an affiliate as a referrer for another affiliate. This action cannot be performed as a batch action.

Click the Perform Action button to perform your specified action to your selected affiliates.

You can also perform various actions to individual members by using the available Action Icons, detailed below.

Affiliate Action Icons

To the right of each affiliate are several action icons, which allow you to perform certain tasks involving your affiliates.

  • The Affiliate Overview Icon shows the affiliate's account information
  • The Override icon lets you overrides as that affiliate. For more details, please see our NATS4 Affiliate Override wiki article.
  • The Edit Affiliate Details icon lets you change the affiliate's account details page. This will override as the specified affiliate.
  • The Affiliate Statistics icon takes you to the affiliate's statistics page. This will override as the specified affiliate.
  • The Affiliate Documents icon lets you upload documents for affiliates. For more information, see the Affiliate Documents section below.
  • The Add Manual Sale icon adds a manual sale. For more details, please see our Add Manual Sale wiki article.
  • The Add Manual Invoice icon adds a manual invoice. For more details, see the Manual Invoice article
  • The Edit Affiliate Admin Settings icon lets you change several special settings. For more details, see our NATS4 Affiliate Admin Settings wiki article.
  • The Change Affiliate Password icon changes the affiliate's password
  • The Change Affiliate Status icon lets you Disable or Ban affiliates. For more information, please see our Change Affiliate Status wiki article.
  • The Change API Key icon changes the API key for the specified affiliate. For more information on API keys, please see our NATS4 API wiki article.
  • The Delete Affiliate icon deletes the affiliate's account

Note: NATS automatically hides icons that can't be used by certain affiliates.

Affiliate Access Permissions

To edit affiliate access permissions, click the icon to the left of their account name. The Account Type drop-down menu on this page has six options ordered from least access to most access:

For more information on the Affiliate Access Permissions feature, please see our NATS4 Affiliate Access Permissions wiki article.

Affiliate Documents

NATS lets you upload and send documents to affiliates. To do so, go to the Affiliates Admin, select the affiliate you want, and click the Affiliate Documents icon. Once you are on the Documents page, you can use the field there to upload and send documents to this affiliate-- existing documents will be listed on the page.

Uploading Documents in NATS

Before you can begin uploading documents for your affiliates, you must first make allowances for file extensions and IPs in the Configuration Admin. Go to the "Security" section of the Configuration Admin and scroll down to the "Document Upload" settings. Here, you will find two configuration settings regarding document uploads:

  • DOCUMENTS_SECURE_EXT - Input what file extensions you wish to allow in a comma-separated list. For example: .doc,.txt,.docx
  • DOCUMENTS_SECURE_IPS - Input what IPs will be allowed to upload documents in a comma-separated list.

Example Documents

  • Uploading an image of the resellers W9 form
  • Uploading an image of documents pertaining to instant payments

Affiliate Admin Settings

Affiliate Admin Settings allows you to customize affiliates beyond the standard settings. Here you can manually mark In-House Accounts, indicate that certain documents have been received, set trust levels, and allow features like instant payments and manual invoices.

For more information on Affiliate Admin Settings, please see our NATS4 Affiliate Admin Settings wiki article.

When you are done further configuring your affiliate, click Save Changes.

Manual Invoices

NATS allows you to give a one-time credit to an affiliate with a manual invoice. With this option, the affiliate will be paid the additional amount the next time you store payments.

Warning: after you make a manual invoice, you can not remove it; you must pay the affiliate.

To add a manual invoice, you must first enable them in the Affiliates Admin. Find the affiliate you wish to allow manual invoices for, and click the Edit Affiliate Admin Settings icon. Under "Main Settings", enable the Manual Invoices check-box and click Save Changes.
Admin actions.png
Once you have done this, return to the main Affiliate Admin, find the affiliate again, and click the new Add Manual Invoice icon.


Admin actions invoices.png

Enter the amount to pay the affiliate and click Add Invoice.
Manual invoices table.png

Retrieved from "https://tmmwiki.com/index.php?title=NATS4_Affiliates_Admin&oldid=23696"