Difference between revisions of "NATS4 Affiliate Postback New"
Tmm vincent (talk | contribs) m (Corrected spelling & changed colors in examples) |
|||
| Line 9: | Line 9: | ||
==Configuration Admin == | ==Configuration Admin == | ||
| − | If you would like to enable this feature for your affiliates, go to the Configuration Admin and select the "Affiliates" tab from the "Current Section" drop-down menu. You will then see a list of options to activate under the ''Postbacks'' sub-section. The following is a list of the possible postbacks your affiliates can receive: | + | If you would like to enable this feature for your affiliates, go to the Configuration Admin and select the "Affiliates" tab from the "Current Section" drop-down menu. You will then see a list of options to activate under the ''Postbacks'' sub-section. The following is a list of the possible postbacks your affiliates can receive:<br> |
| + | '''Note: As of NATS v5.0.2.5, these settings are enabled by default''' | ||
* '''AFFILIATE_POST_MEMBER_APPROVAL''' - Allow affiliates to receive a postback on member approval (includes perminute, seconds, initial and trial). | * '''AFFILIATE_POST_MEMBER_APPROVAL''' - Allow affiliates to receive a postback on member approval (includes perminute, seconds, initial and trial). | ||
| Line 35: | Line 36: | ||
* '''AFFILIATE_POST_MEMBER_PENDING_NCR''' - Allow affiliates to receive a postback on member pending NCR. | * '''AFFILIATE_POST_MEMBER_PENDING_NCR''' - Allow affiliates to receive a postback on member pending NCR. | ||
| − | The following is a list of the possible NATS stored information your affiliates can use to filter which postback variables they need sent: | + | The following is a list of the possible NATS stored information your affiliates can use to filter which postback variables they need sent:<br> |
| + | '''Note: As of NATS v5.0.2.5, these settings are enabled by default (other than AFFILIATE_POST_EXTRA_VARS_BILLERID)''' | ||
* '''AFFILIATE_POST_EXTRA_VARS_CAMPAIGNID''' - Allow affiliates to post extra variables based on the campaign ID used. | * '''AFFILIATE_POST_EXTRA_VARS_CAMPAIGNID''' - Allow affiliates to post extra variables based on the campaign ID used. | ||
Latest revision as of 12:28, 28 May 2020
NATS4 has to ability to post detailed member information to your affiliates based on any basic action the member takes through NATS. This is made possible by using a backend POST, which is based on the basic actions the member takes in NATS. For other postback examples, please check this article: NATS4 Postbacks and Post URLs. If you require additional variables to be included in your postbacks, please check this article: NATS4 Additional Tracking
To use this feature, you must first activate it in the Configuration Admin. When it is activated, your affiliates will be able to receive detailed transaction-based information to a script that they configure.
Configuration Admin
If you would like to enable this feature for your affiliates, go to the Configuration Admin and select the "Affiliates" tab from the "Current Section" drop-down menu. You will then see a list of options to activate under the Postbacks sub-section. The following is a list of the possible postbacks your affiliates can receive:
Note: As of NATS v5.0.2.5, these settings are enabled by default
- AFFILIATE_POST_MEMBER_APPROVAL - Allow affiliates to receive a postback on member approval (includes perminute, seconds, initial and trial).
- AFFILIATE_POST_MEMBER_PERMINUTE - Allow affiliates to receive a postback on member perminute approval.
- AFFILIATE_POST_MEMBER_SECONDS - Allow affiliates to receive a postback on member seconds approval.
- AFFILIATE_POST_MEMBER_INITIAL - Allow affiliates to receive a postback on member initial approval.
- AFFILIATE_POST_MEMBER_TRIAL - Allow affiliates to receive a postback on member trial approval.
- AFFILIATE_POST_MEMBER_REBILL - Allow affiliates to receive a postback on member rebill.
- AFFILIATE_POST_MEMBER_UPGRADE - Allow affiliates to receive a postback on member upgrade.
- AFFILIATE_POST_MEMBER_EXPIRE - Allow affiliates to receive a postback on member expire.
- AFFILIATE_POST_MEMBER_INSUFFICIENT_FUND - Allow affiliates to receive a postback on member insufficient funds.
- AFFILIATE_POST_MEMBER_CREDIT - Allow affiliates to receive a postback on member credit.
- AFFILIATE_POST_MEMBER_CHARGEBACK - Allow affiliates to receive a postback on member chargeback.
- AFFILIATE_POST_MEMBER_VOID - Allow affiliates to receive a postback on member void.
- AFFILIATE_POST_MEMBER_UPGRADEDENY - Allow affiliates to receive a postback on member upgrade denial.
- AFFILIATE_POST_MEMBER_CHANGE_DETAILS - Allow affiliates to receive a postback on member change details.
- AFFILIATE_POST_MEMBER_VOID_REVERSAL - Allow affiliates to receive a postback on member void reversal.
- AFFILIATE_POST_MEMBER_CREDIT_REVERSAL - Allow affiliates to receive a postback on member credit reversal.
- AFFILIATE_POST_MEMBER_CHARGEBACK_REVERSAL - Allow affiliates to receive a postback on member chargeback reversal.
- AFFILIATE_POST_MEMBER_INSUFFICIENT_FUNDS_REVERSAL - Allow affiliates to receive a postback on member insufficient funds reversal.
- AFFILIATE_POST_MEMBER_PRE_APPROVAL - Allow affiliates to receive a postback on member pre (note) approval.
- AFFILIATE_POST_MEMBER_PRE_REBILL - Allow affiliates to receive a postback on member pre (note) rebill.
- AFFILIATE_POST_MEMBER_PENDING_APPROVAL - Allow affiliates to receive a postback on member pending approval.
- AFFILIATE_POST_MEMBER_PENDING_REBILL - Allow affiliates to receive a postback on member pending rebill.
- AFFILIATE_POST_MEMBER_PENDING_NCR - Allow affiliates to receive a postback on member pending NCR.
The following is a list of the possible NATS stored information your affiliates can use to filter which postback variables they need sent:
Note: As of NATS v5.0.2.5, these settings are enabled by default (other than AFFILIATE_POST_EXTRA_VARS_BILLERID)
- AFFILIATE_POST_EXTRA_VARS_CAMPAIGNID - Allow affiliates to post extra variables based on the campaign ID used.
- AFFILIATE_POST_EXTRA_VARS_PROGRAMID - Allow affiliates to post extra variables based on the prmgraid ID used.
- AFFILIATE_POST_EXTRA_VARS_SITEID - Allow affiliates to post extra variables based on the site ID used.
- AFFILIATE_POST_EXTRA_VARS_TOURID - Allow affiliates to post extra variables based on the tour ID used.
- AFFILIATE_POST_EXTRA_VARS_OPTIONID - Allow affiliates to post extra variables based on the option ID used.
- AFFILIATE_POST_EXTRA_VARS_ADTOOLID - Allow affiliates to post extra variables based on the adtool ID used.
- AFFILIATE_POST_EXTRA_VARS_SUBID1 - Allow affiliates to post extra variables based on the sub ID 1 used.
- AFFILIATE_POST_EXTRA_VARS_SUBID2 - Allow affiliates to post extra variables based on the sub ID 2 used.
- AFFILIATE_POST_EXTRA_VARS_BILLERID - Allow affiliates to post extra variables based on the biller ID used.
- AFFILIATE_POST_EXTRA_VARS_COUNTRYID - Allow affiliates to post extra variables based on the country ID used.
- AFFILIATE_POST_EXTRA_VARS_PROMOTIONALID - Allow affiliates to post extra variables based on the promotional ID used.
Affiliate Configuration
Once you have activated the postbacks you want your affiliates to be able to receive, your affiliates will be able to configure their postbacks. To configure the postbacks, the affiliate can click the Settings link under the My Account menu. Once the account settings page is displayed, the affiliate can access the postbacks by clicking the Postback Settings tab. (This link will not be available if none of the postbacks are allowed)
Once on the "Postback Settings" page, your affiliates can add postback URLs:
Postback URL
And custom postback variables:
Postback Variables
Affiliates can configure multiple Postback Variables per transaction type. NATS will combine all the Postback Variables that meet the affiliate's configuration. Consider the following:
Your NATS install is using EPOCH and CCBill. The affiliate configures three (3) Extra Postback Varaiables 1. Sends everything for all traffic 2. Sends a variable for EPOCH 3. Sends a variable for CCBILL. If a CCBill transaction is processed, NATS will combine the variables from the first (everything) and last (CCBILL) Extra Postback Variables.
Affiliates can have NATS pass back custom information sent to NATS via the NATS subscription passthrough variables. For more information: NATS4 Additional Tracking
Postback Format
If the affiliate adds an Extra Postback Variable without any Extra Variables defined, NATS will send all of the non-empty variables defined below:
| Variable Name | Description | ||
| identid | The NATS identifier used to internally associate a member with a campaign, program, site, tour, option, adtool, biller, and country. | ||
| loginid | The numeric NATS loginid of the affiliate receiving the post. | ||
| login_username | The alpha-numeric name of the affiliate receiving the post. | ||
| status | The status of the member that caused the post to trigger. (0 = never joined, 1 = active, 2 = expired) | ||
| trial | Set to 1 if the member who triggered the post is currently marked as a trial member. | ||
| joined | The date the member joined (as a UNIX timestamp). | ||
| expired | The date the member expired in NATS (as a UNIX timestamp). | ||
| siteid | The numeric NATS siteid that the member joined under. | ||
| statid | The numeric NATS statid that links the member to a stat record in the NATS database. | ||
| billerid | The numeric NATS billerid that the member processed their transaction. | ||
| optionid | The numeric NATS optionid that the member joined under. | ||
| forced_optionid | The numeric forced_optionid that the member joined under. | ||
| default_optionid | The numeric defaulted_optionid presented to the member. | ||
| rebills | The number of rebills the member has had since joining. | ||
| expires | The date the member is supposed to expire in NATS (as a UNIX timestamp). | ||
| campaignid | The numeric campaignid of which the the member was tracked. | ||
| campaign_name | The alpha-numeric name of the campaign which the the member was tracked. | ||
| programid | The numeric programid of which the the member was tracked. | ||
| tourid | The numeric tourid of which the the member was tracked. | ||
| adtoolid | The numeric adtoolid of which the the member was tracked. | ||
| subid1 | The numeric subid1 of which the the member was tracked. | ||
| subid2 | The numeric subid2 of which the the member was tracked. | ||
| countryid | The numeric countryid of which the the member was tracked. | ||
| promotionalid | The numeric promotionalid of which the the member was tracked. | ||
| custom1 | The alpha-numeric custom1 variable assigned to the member. | ||
| custom2 | The alpha-numeric custom2 variable assigned to the member. | ||
| custom3 | The alpha-numeric custom3 variable assigned to the member. | ||
| custom4 | The alpha-numeric custom4 variable assigned to the member. | ||
| custom5 | The alpha-numeric custom5 variable assigned to the member. | ||
| custom6 | The alpha-numeric custom6 variable assigned to the member. | ||
| custom7 | The alpha-numeric custom7 variable assigned to the member. | ||
| custom8 | The alpha-numeric custom8 variable assigned to the member. | ||
| custom9 | The alpha-numeric custom9 variable assigned to the member. | ||
| custom10 | The alpha-numeric custom10 variable assigned to the member. | ||
| passthrough1 | The alpha-numeric passthrough1 variable assigned to the member. | ||
| passthrough2 | The alpha-numeric passthrough2 variable assigned to the member. | ||
| passthrough3 | The alpha-numeric passthrough3 variable assigned to the member. | ||
| passthrough4 | The alpha-numeric passthrough4 variable assigned to the member. | ||
| passthrough5 | The alpha-numeric passthrough5 variable assigned to the member. | ||
| Additional Parameter | (available in NATS versions 4.1.7.1 and later) | ||
| amount | The dollar amount that the affiliate earned for this member's signup. |
If the affiliate only wants some of the variables listed, they should format the value pair in querystring format as follows:
{Index}=%%{Variable}%%
Example:
a=%%campaignid%%&b=%%amount%%
If the affiliate wants to get all the available NATS variables and a custom variable(s), they should format the Extra Variables field as follows:
{Index}=%%{Variable}%%&%%everything%% or {Index}=%%{Variable}%%&%%everything%% or {Index}=%%{Variable}%%&%%everything%%&{Index}={Variable}
Example:
a=xxx&%%everything%%&b=yyy
