Difference between revisions of "NATS4 Affiliate Postback"

From TMM Wiki
Jump to navigationJump to search
Line 61: Line 61:
 
== Postback Format ==
 
== Postback Format ==
  
−
For detailed information on what information we send in the postbacks, and what format the information is in, please refer to the follow wiki article: (still being written)
+
We will send the following information in the query string:
−
 
 
  
 +
{|
 +
|-
 +
|<u>'''Variable Name'''</u>
 +
|<u>'''Description'''</u>
 +
|-
 +
|<tt>identid</tt>
 +
| The NATS identifier used to internally associate a member with a campaign, program, site, tour, option, adtool, biller, and country.
 +
|-
 +
|<tt>loginid</tt>
 +
| The numeric NATS loginid for the affiliate receiving the post.
 +
|-
 +
|<tt>status</tt>
 +
| The status of the member that caused the post to trigger.  (0 = never joined, 1 = active, 2 = expired)
 +
|-
 +
|<tt>trial</tt>
 +
| Set to 1 if the member who triggered the post is currently marked as a trial member.
 +
|-
 +
|<tt>joined</tt>
 +
| The date the member joined (as a UNIX timestamp).
 +
|-
 +
|<tt>expired</tt>
 +
| The date the member expired in NATS (as a UNIX timestamp).
 +
|-
 +
|<tt>siteid</tt>
 +
| The numeric NATS siteid that the member joined under.
 +
|-
 +
|<tt>cascadeid</tt>
 +
| The numeric cascadeid that the member followed when they first joined.
 +
|-
 +
|<tt>cascade_item_id</tt>
 +
| The numeric id of the cascade step the member hit when their transaction was approved.
 +
|-
 +
|<tt>statid</tt>
 +
| The numeric NATS statid that links the member to a stat record in the NATS database.
 +
|-
 +
|<tt>billerid</tt>
 +
| The numeric NATS billerid that the member processed their transaction.
 +
|-
 +
|<tt>optionid</tt>
 +
| The numeric NATS optionid that the member joined under.
 +
|-
 +
|<tt>rebills</tt>
 +
| The number of rebills the member has had since joining.
 +
|-
 +
|<tt>expires</tt>
 +
| The date the member is supposed to expire in NATS (as a UNIX timestamp).
 +
|-
 +
|<tt>original_optionid</tt>
 +
| The original optionid that the member chose when they visited the NATS pre-join page.
 +
|}
 
[[Category:NATS4 Administrator Guide]]
 
[[Category:NATS4 Administrator Guide]]

Revision as of 13:19, 22 January 2009

NATS 4
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
NATS Configuration Admin
The Configuration Admin
Log Admin Activity
IP Address Filtering
MEMBER_EXPIRE_PAD
SKIP COUNTRIES
Fraud Configuration
Email Configuration
Affiliate Signup Email
Affiliate Postback
Affiliate Postback NEW
Affiliate Analytics
Throttling
NATS4 Terms of Service feature
GeoIP2

NATS4 has the ability to post detailed member information to your affiliates via a backend POST based on any basic action the member takes through NATS. You must first activate this feature in your NATS Configuration Admin, then your affiliates can receive detailed information on what their members are doing.


Configuration Admin

To enable this feature for your affiliates, please visit the Configuration Admin -> Affiliates tab. In the sub-section labeled Postbacks, you will see a list of options to activate. Here are a list of the possible postbacks your affiliates can receive:


AFFILIATE_POSTBACK_MEMBER_APPROVAL Allow affiliates to receive a postback when one of their members signs up.
AFFILIATE_POSTBACK_MEMBER_REBILL Allow affiliates to receive a postback when one of their members rebills.
AFFILIATE_POSTBACK_MEMBER_UPGRADE Allow affiliates to receive a postback when one of their members upgrades.
AFFILIATE_POSTBACK_MEMBER_EXPIRE Allow affiliates to receive a postback when one of their members expires.
AFFILIATE_POSTBACK_MEMBER_INSUFFICIENT_FUND Allow affiliates to receive a postback when one of their members has an "insufficient funds" transaction.
AFFILIATE_POSTBACK_MEMBER_CREDIT Allow affiliates to receive a postback when one of their members credit.
AFFILIATE_POSTBACK_MEMBER_CHARGEBACK Allow affiliates to receive a postback when one of their members chargeback.
AFFILIATE_POSTBACK_MEMBER_VOID Allow affiliates to receive a postback when one of their members has a void transaction.
AFFILIATE_POSTBACK_MEMBER_UPGRADEDENY Allow affiliates to receive a postback when one of their members upgrade denial.
AFFILIATE_POSTBACK_MEMBER_CHANGE_DETAILS Allow affiliates to receive a postback when one of their members changes their details (such as username/password).


Affiliate Configuration

After you've activated the postbacks you want your affiliate be able to receive, your affiliates can then login and enter the URL(s) where they want their postback(s) to be sent. The affiliate needs to go to their "My Account" page...

My Account Circled.jpg

Then click on the "Account Settings" tab. They should see a new box on this page that will look something like this (by default):

Affiliate Postback Settings.jpg

From there they can enter the URL(s) of the script(s) that will handle their postbacks.

Postback Format

We will send the following information in the query string:

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 for 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.
cascadeid The numeric cascadeid that the member followed when they first joined.
cascade_item_id The numeric id of the cascade step the member hit when their transaction was approved.
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.
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).
original_optionid The original optionid that the member chose when they visited the NATS pre-join page.
Retrieved from "https://tmmwiki.com/index.php?title=NATS4_Affiliate_Postback&oldid=7336"