Difference between revisions of "NATS4 API Add Affiliate"
From TMM Wiki
Jump to navigationJump to search| (3 intermediate revisions by 3 users not shown) | |||
| Line 2: | Line 2: | ||
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
| − | To add an affiliate you must make a SOAP call with the following parameters: | + | |
| + | To add an affiliate through the [[NATS4]] API, you must make a SOAP call with the following parameters: | ||
| + | |||
<pre> | <pre> | ||
<?xml version="1.0" encoding="ISO-8859-1"?> | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
| − | <SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" | + | <SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="urn:natsapiadmin_wsdl"> |
| − | xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" | ||
| − | xmlns:tns="urn:natsapiadmin_wsdl"> | ||
<SOAP-ENV:Body> | <SOAP-ENV:Body> | ||
<tns:add_affs xmlns:tns="urn:natsapiadmin_wsdl"> | <tns:add_affs xmlns:tns="urn:natsapiadmin_wsdl"> | ||
| Line 37: | Line 37: | ||
'''NOTE: The ref field is for passing in an affiliate referral. The value is the loginid of the referring affiliate.''' | '''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: | |
| + | |||
<pre> | <pre> | ||
<?xml version="1.0" encoding="ISO-8859-1"?> | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
| − | <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" | + | <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="urn:natsapiadmin_wsdl"> |
| − | xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="urn:natsapiadmin_wsdl"> | ||
<SOAP-ENV:Body> | <SOAP-ENV:Body> | ||
<ns1:add_affsResponse xmlns:ns1="urn:natsapiadmin_wsdl"> | <ns1:add_affsResponse xmlns:ns1="urn:natsapiadmin_wsdl"> | ||
| Line 54: | Line 54: | ||
</SOAP-ENV:Envelope> | </SOAP-ENV:Envelope> | ||
</pre> | </pre> | ||
| − | The response | + | |
| − | If the | + | 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 | + | |
| + | 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 [[NATS4_API#Example|main article NuSOAP Example]]): | ||
| + | |||
| + | <pre> | ||
| + | $values = array( | ||
| + | 'username' => 'myaffusername', | ||
| + | 'password' => 'myaffpassword', | ||
| + | 'firstname' => 'testing', | ||
| + | 'lastname' => 'testerson', | ||
| + | 'email' => 'testemail@test.com', | ||
| + | 'company' => 'Company', | ||
| + | 'url' => 'http://testing.com', | ||
| + | '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']); | ||
| + | } | ||
| + | print_r($result); | ||
| + | </pre> | ||
| + | |||
| + | [[Category:NATS4 API Articles]] | ||
Latest revision as of 21:31, 19 February 2013
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="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="urn:natsapiadmin_wsdl"> <SOAP-ENV:Body> <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">foo@bar.com</email> <company xsi:nil="true" xsi:type="xsd:string"/> <url xsi:type="xsd:string">http://www.foo.com</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> </tns:add_affs> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
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="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="urn:natsapiadmin_wsdl"> <SOAP-ENV:Body> <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> </item> </return> </ns1:add_affsResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
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' => 'testemail@test.com',
'company' => 'Company',
'url' => 'http://testing.com',
'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']);
}
print_r($result);
