NATS5 Affiliate Overview

From TMMwiki
Jump to: navigation, search
NATS 5
Affiliates Section
Affiliate Management
Affiliate Overview
Affiliate Override
Affiliate Groups
Affiliate Account Types
Affiliate Account Changes
Adding a Manual Sale
Members Section
Members Management
Adding a Member
View Member Details
Restricted Values

    Adtool
GET /adtool/admin
GET /adtool/adtools
GET /adtool/adtool
GET /adtool/adtool-rules
GET /adtool/adtool-rule
GET /adtool/categories
GET /adtool/field-options
GET /adtool/field-types
GET /adtool/groups
GET /adtool/search
GET /adtool/templates
GET /adtool/types
GET /adtool/type
POST /adtool/adtool
POST /adtool/adtool-rule
POST /adtool/category
POST /adtool/field
POST /adtool/field-option
POST /adtool/group
POST /adtool/import
POST /adtool/type
PATCH /adtool/adtool
PATCH /adtool/adtool-group
PATCH /adtool/adtool-rule
PATCH /adtool/category
PATCH /adtool/field
PATCH /adtool/field-option
PATCH /adtool/group
PATCH /adtool/move
PATCH /adtool/restore-adtool
PATCH /adtool/restore-category
PATCH /adtool/restore-field
PATCH /adtool/restore-field-option
PATCH /adtool/restore-type
PATCH /adtool/type
DELETE /adtool/adtool
DELETE /adtool/adtool-rule
DELETE /adtool/category
DELETE /adtool/field
DELETE /adtool/field-option
DELETE /adtool/group
DELETE /adtool/type
    Affiliate
DELETE /affiliate/account-rep
DELETE /affiliate/account-type
DELETE /affiliate/affiliate
DELETE /affiliate/doc
DELETE /affiliate/group
DELETE /affiliate/permissions
GET /affiliate/account-changes
GET /affiliate/account-types
GET /affiliate/admin-settings
GET /affiliate/campaigns
GET /affiliate/current
GET /affiliate/current-permissions
GET /affiliate/docs
GET /affiliate/doc
GET /affiliate/groups
GET /affiliate/group
GET /affiliate/hits
GET /affiliate/link-styles
GET /affiliate/loginids
GET /affiliate/loginlog
GET /affiliate/manual-payout
GET /affiliate/news-sections
GET /affiliate/notes
GET /affiliate/notices
GET /affiliate/override
GET /affiliate/payout
GET /affiliate/payment-periods
GET /affiliate/payvia-types
GET /affiliate/payvia-type
GET /affiliate/permissions
GET /affiliate/programcampaigns
GET /affiliate/referrer
GET /affiliate/referring-urls
GET /affiliate/reps
GET /affiliate/rest-methods
GET /affiliate/search
GET /affiliate/search-limited
GET /affiliate/settings
GET /affiliate/skins
GET /affiliate/soap-functions
GET /affiliate/status
PATCH /affiliate/adminsettings
PATCH /affiliate/account-change
PATCH /affiliate/account-type
PATCH /affiliate/account-type-permissions
PATCH /affiliate/admin-setting
PATCH /affiliate/affiliate-account-type
PATCH /affiliate/affiliate-group
PATCH /affiliate/allsettings
PATCH /affiliate/account-rep
PATCH /affiliate/avatar
PATCH /affiliate/customs
PATCH /affiliate/defaults
PATCH /affiliate/details
PATCH /affiliate/override
PATCH /affiliate/password
PATCH /affiliate/payment-period
PATCH /affiliate/payvia
PATCH /affiliate/payvia-info
PATCH /affiliate/permissions
PATCH /affiliate/referrer
PATCH /affiliate/reset-api
PATCH /affiliate/reset-rss
PATCH /affiliate/reset-tos
PATCH /affiliate/rest-permissions
PATCH /affiliate/restore
PATCH /affiliate/restore-account-type
PATCH /affiliate/settings
PATCH /affiliate/soap-permissions
PATCH /affiliate/status
POST /affiliate/account-type
POST /affiliate/add
POST /affiliate/doc
POST /affiliate/group
POST /affiliate/invoice
POST /affiliate/manual-sale
POST /affiliate/note
    Biller
GET /biller/available
GET /biller/partner-available
GET /biller/billerdata
GET /biller/cascades
GET /biller/cascades-available
GET /biller/cascade-count
GET /biller/cascade-history
GET /biller/cascade-rules
GET /biller/cascade-rule
GET /biller/cascade-step-count
GET /biller/cascade-steps
GET /biller/cascade-detail
GET /biller/cascade-list
GET /biller/count
GET /biller/detail
GET /biller/fees
GET /biller/partner-fees
GET /biller/last_poll
GET /biller/partner-last-poll
GET /biller/list
GET /biller/partner-detail
GET /biller/partner-list
GET /biller/partner-shortnames
GET /biller/process_types
GET /biller/partner-process-types
GET /biller/shortnames
GET /biller/transaction_types
GET /biller/partner-transaction-types
GET /biller/taxes
POST /biller/add
POST /biller/cascade
POST /biller/cascade-rule
POST /biller/cascade-step
POST /biller/partner
PATCH /biller/cascade
PATCH /biller/cascade-rule
PATCH /biller/cascade-step
PATCH /biller/cascade-steps-reorder
PATCH /biller/fee
PATCH /biller/partner-fee
PATCH /biller/restore
PATCH /biller/restore-cascade
PATCH /biller/restore-partner
PATCH /biller/setting
PATCH /biller/partner-setting
PATCH /biller/tax
DELETE /biller/biller
DELETE /biller/cascade
DELETE /biller/cascade-rule
DELETE /biller/cascade-step
DELETE /biller/fee
DELETE /biller/partner-fee
DELETE /biller/partner
DELETE /biller/tax
    Codes
GET /codes/affiliate-codes
GET /codes/decode
GET /codes/linkcodes
GET /codes/strack
    Config
DELETE /config/setting
GET /config/section
GET /config/sections
PATCH /config/affiliate_default
PATCH /config/section
    Include
DELETE /include/include
DELETE /include/step
GET /include/include
GET /include/includes
GET /include/templates
PATCH /include/include
PATCH /include/restore
PATCH /include/step
POST /include/include
POST /include/step
    Mailing
DELETE /mailing/mailing
DELETE /mailing/mailing-rule
DELETE /mailing/queue
GET /mailing/mailing
GET /mailing/mailings
GET /mailing/mailing-rules
GET /mailing/mailing-rule
GET /mailing/queue
GET /mailing/removelist
PATCH /mailing/mailing
PATCH /mailing/mailing-rule
PATCH /mailing/removelist
PATCH /mailing/removelist-queue
PATCH /mailing/resend-queue
PATCH /mailing/restore-queue
PATCH /mailing/send-mailing
PATCH /mailing/send-test-mailing
POST /mailing/mailing
POST /mailing/mailing-rule
POST /mailing/removelist
    Maintenance
DELETE /maintenance/log
DELETE /maintenance/cache
GET /maintenance/admin-actions
GET /maintenance/log
GET /maintenance/logs
GET /maintenance/nats
GET /maintenance/report
GET /maintenance/report-progress
GET /maintenance/reports
GET /maintenance/server
GET /maintenance/table
GET /maintenance/tables
GET /maintenance/table-clean-count
GET /maintenance/table-clean-progress
PATCH /maintenance/log
PATCH /maintenance/report
PATCH /maintenance/table
    Member
GET /member/available_flags
GET /member/encryptusername
GET /member/authstring
GET /member/details
GET /member/flags
GET /member/loginlog
GET /member/matching
GET /member/notes
GET /member/notices
GET /member/restricted-values
GET /member/search
GET /member/suggestedcanceloffers
GET /member/surfer-actions
PATCH /member/details
PATCH /member/expiration
PATCH /member/expiremanual
PATCH /member/resend-transaction-email
PATCH /member/resend-transaction-postback
PATCH /member/restricted-value
PATCH /member/forget
PATCH /member/lock
PATCH /member/unlock
POST /member/flag
POST /member/login
POST /member/note
POST /member/restricted-value
DELETE /member/flag
DELETE /member/restricted-value
    Message
DELETE /message/message
DELETE /message/permanent
GET /message/count
GET /message/messages
GET /message/view
PATCH /message/read
PATCH /message/unread
PATCH /message/undelete
POST /message/message
    News
DELETE /news/entry
DELETE /news/section
GET /news/entry
GET /news/news
GET /news/sections
PATCH /news/entry
POST /news/entry
POST /news/section
    Notification
DELETE /notification/notification
DELETE /notification/permanent
GET /notification/count
GET /notification/notifications
GET /notification/view
PATCH /notification/read
PATCH /notification/unread
PATCH /notification/undelete
    Option
GET /option/options
GET /option/rule
PATCH /option/rule
PATCH /option/text
POST /option/rule
    Payment
DELETE /payment/invoice
DELETE /payment/payout-period
DELETE /payment/payvia-field
DELETE /payment/payvia-field-mc
DELETE /payment/payvia-rule
GET /payment/dump-format
GET /payment/dump-formats
GET /payment/invoices
GET /payment/payments
GET /payment/payment-dumps
GET /payment/payment-dump
GET /payment/payment-search
GET /payment/payvia
GET /payment/payvias
GET /payment/payvia-fields
GET /payment/payvia-field-mcs
GET /payment/payout-period
GET /payment/payout-periods
GET /payment/payvia-rules
GET /payment/payvia-rule
GET /payment/payviarule
PATCH /payment/copy-dump-format
PATCH /payment/default-payout-period
PATCH /payment/dump-format
PATCH /payment/duplicate-payvia
PATCH /payment/invoice
PATCH /payment/payment
PATCH /payment/payment-paid
PATCH /payment/payment-store
PATCH /payment/payment-unstore
PATCH /payment/payments
PATCH /payment/payments-unstore
PATCH /payment/payout-period
PATCH /payment/payout-period-affiliates
PATCH /payment/payvia
PATCH /payment/payvia-field
PATCH /payment/payvia-fields-reorder
PATCH /payment/payvia-field-mc
PATCH /payment/payvia-field-mcs-reorder
PATCH /payment/payvia-rule
PATCH /payment/payviarule
PATCH /payment/restore-payout-period
PATCH /payment/restore-payvia-field
PATCH /payment/restore-payvia-field-mc
POST /payment/check-dump
POST /payment/dump-format
POST /payment/import-dump
POST /payment/invoice
POST /payment/payout-period
POST /payment/payvia
POST /payment/payvia-field
POST /payment/payvia-field-mc
POST /payment/payvia-rule
    Program
DELETE /program/program
DELETE /program/payout-change
DELETE /program/payout-change-tier
GET /program/additional-payout-change-targets
GET /program/affiliate-available
GET /program/detail
GET /program/list
GET /program/options
GET /program/payout-changes
GET /program/redirect-available
GET /program/sites
GET /program/tours
GET /program/types
PATCH /program/default_payout
PATCH /program/details
PATCH /program/disable_affiliate
PATCH /program/disable_tour
PATCH /program/enable_affiliate
PATCH /program/enable_site
PATCH /program/enable_tour
PATCH /program/move-payout-change
PATCH /program/payout-change
PATCH /program/payout-change-tier
POST /program/new
POST /program/payout-change
POST /program/payout-change-tier
    Report
GET /report/affiliate-ratios
GET /report/hits
GET /report/hit-totals
GET /report/profitloss
GET /report/profit-loss
GET /report/fields
GET /report/focus
GET /report/focuses
GET /report/groups
GET /report/perspective
GET /report/perspectives
GET /report/report
GET /report/subscription
GET /report/surfer
GET /report/surferaction
GET /report/transactionpayouts
GET /report/transactions
GET /report/transaction
GET /report/report-widget
GET /report/widgets
GET /report/widget
GET /report/widget-info
GET /report/views
POST /report/focus
POST /report/group
POST /report/perspective
PATCH /report/focus
PATCH /report/focus-enabled
PATCH /report/focus-default
PATCH /report/focuses-reorder
PATCH /report/perspective
PATCH /report/perspective-group
PATCH /report/report-widget
PATCH /report/widget
DELETE /report/focus
    Reward
DELETE /reward/category
DELETE /reward/purchase
DELETE /reward/point
DELETE /reward/reward
GET /reward/categories
GET /reward/points
GET /reward/purchases
GET /reward/rewards
PATCH /reward/move-point
PATCH /reward/point
PATCH /reward/reward
PATCH /reward/ship-purchase
PATCH /reward/unship-purchase
POST /reward/category
POST /reward/point
POST /reward/reward
    Service
GET /service/check-functions
GET /service/condition
GET /service/countries
GET /service/country
GET /service/datetime
GET /service/languages
GET /service/periods
GET /service/ping
GET /service/project
GET /service/rule-condition-data
GET /service/rule-info
GET /service/stats-breakdowns
GET /service/timezone
GET /service/timestamp
POST /service/sendemail
    Site
GET /site/base-templates
GET /site/billers
GET /site/cookies
GET /site/coupon
GET /site/coupons
GET /site/coupon-revisions
GET /site/email-settings
GET /site/groups
GET /site/option
GET /site/options
GET /site/options-available
GET /site/option-fields
GET /site/option-rules
GET /site/option-rule
GET /site/option-type
GET /site/option-types
GET /site/programs
GET /site/redirect
GET /site/redirects
GET /site/redirect-rules
GET /site/redirect-rule
GET /site/site-list
GET /site/site
GET /site/site-notices
GET /site/site-partner
GET /site/site-partners
GET /site/site-type
GET /site/sites
GET /site/template
GET /site/templates
GET /site/template-sections
GET /site/template-sites
GET /site/tour
GET /site/tours
GET /site/tour-emails
GET /site/tour-notices
POST /site/coupon
POST /site/group
POST /site/option
POST /site/option-rule
POST /site/redirect
POST /site/redirect-rule
POST /site/site-partner
POST /site/site-tour
POST /site/copy-template
POST /site/tour
PATCH /site/cookie
PATCH /site/coupon
PATCH /site/duplicate-option
PATCH /site/email-settings
PATCH /site/group
PATCH /site/move
PATCH /site/option
PATCH /site/option-rule
PATCH /site/redirect
PATCH /site/redirect-rule
PATCH /site/reset-coupon
PATCH /site/restore-group
PATCH /site/restore-option
PATCH /site/restore-redirect
PATCH /site/restore-site
PATCH /site/restore-site-partner
PATCH /site/restore-tour
PATCH /site/site
PATCH /site/site-partner
PATCH /site/template
PATCH /site/tour
DELETE /site/cookie
DELETE /site/group
DELETE /site/option
DELETE /site/option-rule
DELETE /site/site
DELETE /site/site-partner
DELETE /site/redirect
DELETE /site/redirect-rule
DELETE /site/template
DELETE /site/tour
DELETE /site/tour-field
    Skin
DELETE /skin/skin
DELETE /skin/template
GET /skin/colors
GET /skin/export
GET /skin/skins
GET /skin/sections
GET /skin/templates
GET /skin/template
PATCH /skin/colors
PATCH /skin/flush
PATCH /skin/skin
PATCH /skin/template
POST /skin/copy-template
POST /skin/import
POST /skin/skin
POST /skin/template

The Affiliate Overview displays the affiliate's account information.
Affiliate-Overview.jpg

Details Tab

The Details Tab displays general information about the affiliate. This includes:

Main Affiliate Details

  • Affiliate ID: The affiliate's ID.
  • Username: The affiliate's username.
  • First Name: The affiliate's first name.
  • Last Name: The affiliate's last name.
  • Company: The company the affiliate belongs to.
  • Country: The country the affiliate belongs to.
  • Affiliate URL: The website of the affiliate.
  • Account Type: The account level of the affiliate. This defines specific permissions for this Affiliate throughout your system. See the Permissions Tab section below for more details.
  • Status: The status of the affiliate, which can be updated by clicking the "Update" link next to the status. This can be set to Active, Disabled, or Banned, and you can input the public and internal reason why the affiliate was set to the chosen status.
  • In-House: This tells whether this particular affiliate works for you. Designating an employee as an in-house account is useful, as you can prevent affiliate payouts from being built for that particular account, thus preventing unwanted payouts.
  • Reffered By: This will display the affiliate referrer if it is set.
  • Account Rep: Displays the account rep associated with this affiliate. This can be updated by clicking the "Update" link, where an account rep and program can be chosen, or the account rep can be deleted.
  • Groups: Displays the group name that the affiliate is a part of. This can be updated by clicking the "Update" link next to the group, where a new group can be created or the affiliate can be added to an existing group. For more information, please see our NATS5 Affiliate Groups wiki.
  • Joined On: The day the affiliate joined your NATS.
  • Join IP: The IP address of the affiliate when they joined your NATS. Clicking the magnifying glass button next to the IP will give more information about this location.
  • Last Log-in: The last login date of the affiliate.


Account Details

  • Password: The password of the affiliate account. This can be reset by clicking the reset link next to the password.
  • Manual Invoices: Specifies whether the affiliate has the ability to make manual invoices.
  • Has Required Docs: Details whether the affiliate has completed the required documents.
  • Agreed to T.O.S.: Specifies if the affiliate has agreed to the NATS Terms of Service.
  • Account Reviewed: Specifies if this affiliate been reviewed. *
  • Trust Level: Specifies how much do you trust this affiliate. *
  • RSS Pass Code: Displays the RSS Pass Code. This can be reset by clicking the "Reset" link next to the code, which will generate a new RSS Pass Code.
  • Allow Subscription Passthrough: Specifies if the affiliate can pass data along with the member signup process.
  • Force Join Option in Linkcodes:
  • Tracking Cookies: How long, in seconds, will the members tracking cookie be valid for this affiliate.
    • Affiliate Global Cookie Expire Time: This will be used for All sites unless otherwise specified below.
    • Site Specific Cookie - Expire Time: Override Global Cookie Settings on a site by site basis.
  • Edit Affiliates and Override as Affiliate: Clicking Update will send you to the Permission tab where you can change either setting for this affiliate.
    • Edit Affiliates: Can this affiliate edit the details of other affiliates?
    • Override as Affiliate: Can this Affiliate override as other affiliates?


Contact Details

  • Address: The address of the affiliate.
  • Address 2: Alternate address of the affiliate.
  • City: The city in which the affiliate resides.
  • State: The state in which the affiliate resides.
  • Zipcode: The zipcode in which the affiliate resides.
  • Email: The email address of the affiliate.
  • Telephone: The telephone number of the affiliate.
  • Contact 1-5: The reseller contacts of the affiliate.


Custom Account Details

  • Custom Fields: Custom fields that can be set for the affiliate.
  • Affiliate Flags: Flags that can be configured for the affiliate.
  • Affiliate Selects: Selects that can be set for the affiliate.

Preferences Tab

The Preferences Tab details various settings for the affiliate.

Affiliate-Overview Preferences.jpg

These settings are all able to be updated and set by the affiliate. As such, these are all settings that are specifically catered to the affiliate and can also be found in the "My Account" tab in the Affiliate Area.

Permissions Tab

Affiliate-Overview Permissions.jpg

Account Type

There are several different Account Types, all with varying permissions:

  • Affiliate: Specifies that the account is a standard affiliate. This account does not have any additional permissions.
  • Account Rep: An account representative can be assigned to manage affiliates.
  • Customer Service Rep: A Customer Service Rep is a special affiliate who is responsible for managing customer services of your membership sites.
  • Site Partner: Site partners typically share revenues and get extra statistics due to their status.
  • Sub Admin: A Sub Admin has limited administrative access and can only view and perform actions on certain admin areas in NATS.
  • TMM Admin: TMM Admins have full administrative access in NATS, but they can only log in from IP addresses specified in the TMM_ADMIN_IPS configuration option. This can be found in the Configuration tab in the "Security" section.
  • Admin: Admins have full administrative access in NATS, and can view and edit whatever they choose. You can also restrict admin access to certain IP's through the "Security" section in the Configuration tab.

Changing the account type will require that the affiliate logs out and log back in to receive their new permissions.

Admin Areas / Navigation

Account Permissions define what the affiliate can view and what actions the affiliate can perform. These permissions are based on the NATS5 Account Types but can be updated to suit the needs of this affiliate.

To update the account type, you have to also have the permissions to be able to update another affiliate's account type. If you have those permissions, then click on the "Update" link next to the account type and select which account type you want that affiliate to have. This will then update the permissions to fit that account type accordingly.

The Permissions table contains the admin section and the corresponding permissions that the affiliate has for that section. This includes:

  • Display: Determines whether the section is displayed for the affiliate.
  • View: Determines whether the affiliate can view the section.
  • Action: Determines whether the affiliate can perform any actions in the section.

By clicking the "Details" button next to the "Action" column, specific affiliate permissions can be updated for each page and each section. When the permissions are set, click "Save Changes".

Global Settings indicates whether the affiliate can edit or override other affiliates.


Programs Tab

Affiliate-Overview Programs.jpg

The Programs Tab displays a list of all the programs in your NATS, as well as whether the affiliate is enabled for that program or not. This tab contains program details, including program ID, the program's short name, and the program type.
The "Affiliates' Default Payout" column details the program's default payout changes. The "Affiliate Has Payout Change" tells whether the affiliate is part of that program's payout, as set on the program's payout page.
To enable the affiliate to a specific program, check the checkbox in the "Enabled in Program" column.


Login Logs Tab

Affiliate-Overview Login Logs.jpg

The Login Logs tab details all of the times the affiliate has logged into your NATS. The details recorded and logged include Time and IP.

Clicking the magnifying glass button next to each log will lookup the IP address.
Other details documented include the Join IP of the affiliate, the Joined On date, and the Last Login time and date.


Acct Changes Tab

The Account Changes tab is similar to the Account Changes link in the left hand navigation, only narrowed to the 1 affiliate you are viewing.

Affiliate-Management Account Changes.jpg

The list itself displays any changes made to this affiliate's account within the affiliate area. Depending on your config settings, the affiliate and/or the admin may be required to approve any changes made to the account.

For more information, please see our NATS5 Account Changes wiki.

Documents Tab

The Documents Tab is where the affiliate can upload documents and displays other document details.

Affiliate-Overview Documents.jpg

To upload a document, click the "Add New" button next to the "Affiliate Documents" title. The document details include the name and file type of the document, the size, whether the affiliate has required documents, whether the affiliate has uploaded a W9 document, and the option to update or upload the affiliate's W9 document by clicking the "Update" link next to the affiliate's W9.

Clicking the "Actions" button next to a document allows you to download or delete that document.


Payments Tab

The Payments Tab provides payment details about the affiliate's payment history.

Affiliate-Overview Payments.jpg

Payment Details

  • Payment Approved: Tells you if a payment was approved.
  • Payment Period: Details the payment period that the affiliate is using, which can be updated by clicking the "Update" link next to the payment period. For more information, please see our NATS5 Payout Periods wiki.
  • W9 Received: Tells whether the W9 for this affiliate was received.
  • Affiliate's W9: The actual W9 document. To upload or remove the W9, click the "Update" link next to the W9.
  • Tax ID or SSN: The affiliate's Tax ID or Social Security Number.
  • Reward Points: How many reward points the affiliate has to remain.
  • Reward Points Used: How many reward points the affiliate has used.


Pay Via Method

This section displays the Pay Via Method set up by the affiliate. To edit the fields for the pay via method for this affiliate, click the "Edit Details" button next to the Pay Via Method title. This tab also allows you to select previously used pay via methods by clicking the "Previous" button next to the "Edit Details" button.

For more information on Pay Via Methods, see our NATS5 Pay Via Methods wiki.

Affiliate Payment Search

Affiliate-Overview Payments Search Widget.jpg

You can search for different affiliate payments by searching for the payment by two different fields, the Affiliate ID and the Payvia Type. All of the results will be filtered out based off of the search.

By clicking the button next to the magnifying glass, you can set the sort option, as well as whether you want the results in Ascending or Descending order and how many results will be displayed per page. The sorting options include Payment ID, Stored Date, Date Range (Start), Amount, and Affiliate Username.

Add Sale

The "Add Sale" button lets you manually add a sale for this affiliate. For more information, please see our NATS5 Manual Sale wiki.

Add Invoice

The "Add Invoice" button allows you to manually add an invoice to the affiliate. For more information, please see our NATS5 Manual Invoice wiki.

Notes Tab

Affiliate-Overview Notes.jpg

The Notes tab holds records of the affiliate notes. Affiliate notes record the date and time of entering that note, as well as display the admin who entered it.

To add a new note, type the note into the text box on the right of the page, and click "Add" when finished.