NATS4 API Add Affiliate

From TMMwiki
Jump to: navigation, search
WSDL Cache
Add Affiliate
Add Member Note
Admin Get Adtools
Adtool Categories
Adtool Types
Affiliate Get Campaigns
Bulk Import Adtools
Decode Natscode
Expire Manual Member
Get Affiliate Campaigns
Get Affiliate Hit Data
Get Affiliate Loginids
Get Affiliate Nats Codes
Get Affiliate Payout
Get Affiliate Program Campaign List
Get Member Details
Get Member Instant Upgrade String
Get Member Package Upgrade String
Get Member Token Rebuy String
Get Member Upsell String
Get Payment Data
Get Payvia Rule
Get Profit Loss Report
Record Member Login
Search Affiliate Info
Search Member Info
Send Email API Function
Set Affiliate Admin Settings
Set Affiliate Customs
Set Affiliate Defaults
Set Affiliate Information
Set Affiliate Settings
Set Member Details
Set Payment Status
Set Payvia Rule
API Overview
GET /adtools/types
GET /adtools/categories
GET /adtools/admin
POST /adtools/importdump
GET /affiliate/hitdata
GET /affiliate/campaigns
GET /affiliate/payout
GET /affiliate/searchinfo
POST /affiliate/addaffiliate
POST /affiliate/invoice
PATCH /affiliate/setcustoms
PATCH /affiliate/setinformation
PATCH /affiliate/setadminsettings
PATCH /affiliate/setpayviainfo
PATCH /affiliate/setdefaults
PATCH /affiliate/setsettings
GET /decodenatscode
GET /member/upsellstring
GET /member/tokenrebuystring
GET /member/instantupgradestring
GET /member/packageupgradestring
GET /member/details
GET /member/cancelstring
GET /member/signupplusstring
GET /member/searchinfo
POST /member/addnote
POST /member/recordlogin
PUT /member/expiremanual
PATCH /member/setdetails
PATCH /member/setexpiration
GET /option/getrule
POST /option/addrule
PUT /option/edittext
PATCH /option/editrule
GET /payments/getpayments
PATCH /payments/setstatus
GET /payviarule
PATCH /payviarule
GET /ping
GET /profitlossreport
POST /sendemail
GET /suggestedcanceloffers

To add an affiliate through the NATS4 API, you must make a SOAP call with the following parameters:

<?xml version="1.0" encoding="ISO-8859-1"?>
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="" xmlns:SOAP-ENV="" xmlns:xsd="" xmlns:xsi="" xmlns:SOAP-ENC="" xmlns:tns="urn:natsapiadmin_wsdl">
		<tns:add_affs xmlns:tns="urn:natsapiadmin_wsdl">
			<username xsi:type="xsd:string">NewAffiliate</username>
			<password xsi:type="xsd:string">AffPass</password>
			<firstname xsi:type="xsd:string">MyFirst</firstname>
			<lastname xsi:type="xsd:string">MyLast</lastname>
			<email xsi:type="xsd:string"></email>
			<company xsi:nil="true" xsi:type="xsd:string"/>
			<url xsi:type="xsd:string"></url>
			<tel xsi:nil="true" xsi:type="xsd:string"/>
			<icq xsi:nil="true" xsi:type="xsd:string"/>
			<aim xsi:nil="true" xsi:type="xsd:string"/>
			<msn xsi:nil="true" xsi:type="xsd:string"/>
			<address1 xsi:type="xsd:string">505 Street Rd.</address1>
			<address2 xsi:nil="true" xsi:type="xsd:string"/>
			<city xsi:type="xsd:string">Freehold</city>
			<state xsi:type="xsd:string">NJ</state>
			<country xsi:type="xsd:string">US</country>
			<zip_code xsi:type="xsd:string">12345</zip_code>
			<tax_id_or_ssn xsi:nil="true" xsi:type="xsd:string"/>
			<ref xsi:type="xsd:string">5</ref>
			<minimum_payout xsi:type="xsd:string">100</minimum_payout>

NOTE: The ref field is for passing in an affiliate referral. The value is the loginid of the referring affiliate.

Once you have made the call, you will get a response similar to:

<?xml version="1.0" encoding="ISO-8859-1"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="" xmlns:xsd="" xmlns:xsi="" xmlns:SOAP-ENC="" xmlns:tns="urn:natsapiadmin_wsdl">
		<ns1:add_affsResponse xmlns:ns1="urn:natsapiadmin_wsdl">
			<return xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:Add_aff[1]">
				<item xsi:type="tns:Add_aff">
					<result xsi:type="xsd:string">1</result>
					<loginid xsi:type="xsd:int">6</loginid>

The response will contain two parameters: result and loginid. If the affiliate was added successfully, then the result will be 1. Otherwise, the response will display an error message with the issue.

If the member addition was successful, then the displayed loginid will be the affiliate's loginid; otherwise the loginid will be set to 0.

NuSOAP Example

This example continues from the main article NuSOAP Example):

$values = array(
	'username' => 'myaffusername',
	'password' => 'myaffpassword',
	'firstname' => 'testing',
	'lastname' => 'testerson',
	'email' => '',
	'company' => 'Company',
	'url' => '',
	'tel' => '1234567890',
	'icq' => '321234145',
	'aim' => 'aimaccount3',
	'msn' => 'msnaccount',
	'address1' => '123 Test Street',
	'address2' => '',
	'city' => 'My City',
	'state' => 'My State',
	'country' => 'USA',
	'zip_code' => '12345',
	'tax_id_or_ssn' => '54-1233245',
	'ref' => 'asdasd',
	'minimum_payout' => '50'
$result = $client->call('add_affs', $values, 'natsapiadmin_wsdl');
if($result) foreach($result as $key => $adtool){
        if($adtool['extra']) $result[$key]['extra'] = unserialize($adtool['extra']);