NATS For Networks REST Add Affiliate
From TMM Wiki
Jump to navigationJump to searchThe printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
POST /affiliate/add_affiliate
Description
- add_affiliate adds a new affiliate
Resource URL
- http://domain/api/affiliate/add_affiliate
- Replace domain with the NATS For Networks domain
Response Format
- JSON
- POST
- HTTP headers
Parameters
Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded
- username
- type: string
- required
- unique
- Affiliate username
- password
- type: string
- required
- Affiliate Password
- payvia
- type: int
- required
- Payvia type id of the payvia type to use with this affiliate
- payvia_info
- type: array
- an array containing field/value pair arrays of payvia information to set for the affiliate
- Must send "payvia" parameter to indicate which payvia type payvia_info is for.
- email
- type: string
- required
- unique
- Email address for this affiliate
- firstname
- type: string
- lastname
- type: string
- company
- type: string
- url
- type: string
- tel
- type: string
- icq
- type: string
- aim
- type: string
- msn
- type: string
- skype
- type: string
- address1
- type: string
- address2
- type: string
- city
- type: string
- state
- type: string
- country
- type: string
- zip_code
- type: string
- tax_id_or_ssn
- type: string
- ref
- type: string
- Tracking code to identifier who referred this affiliate.
- minimum_payout
- type: string
- Threshold for generating affiliate payouts. Affiliate will not be paid until they earn at least this much.
- join_ip
- type: string
- custom1
- type: string
- max 255 characters
- custom2
- type: string
- max 255 characters
- custom3
- type: string
- max 255 characters
- custom4
- type: string
- max 255 characters
- custom5
- type: string
- max 255 characters
- status
- type: int
- Possible values: 0 - Active, 1 - Disabled, 2 - Banned, 3 - Wait on Verify, 4 - Pending, 5 - Denied
Example Request
POST
http://domain/api/affiliate/add_affiliate username = hello password = apitest firstname = hello lastname = test email = hello@n4n.com company = N4N url = natsfornetworks.com tel = 666-666-6666 icq = 666666666 aim = sixsixsix msn = sixsixtysix address1 = 666 666 st address2 = city = My City state = My State country = USA zip_code = 12345 tax_id_or_ssn = 54-1233245 ref = asdasd minimum_payout = 50 join_ip = 192.168.1.1 payvia=1
- Response:
[ { "result":"Success"," "message":{ "loginid":"4003" } } ]
Example Code
PHP
<?php $curl = curl_init(); $url = 'http://domain/api/affiliate/add_affiliate'; $headers = array( 'api-key: 44b5498dbcb481a0d00b404c0169af62', 'api-username: productsupport' ); $data = array( 'username' => 'hello3', 'password' => 'apitest', 'firstname' => 'hello', 'lastname' => 'test', 'email' => 'hello3@offerit.com', 'company' => 'Offerit', 'url' => 'offerit.com', 'tel' => '666-666-6666', 'icq' => '666666666', 'aim' => 'sixsixsix', 'msn' => 'sixsixtysix', 'address1' => '666 666 st', 'address2' => '', 'city' => 'My City', 'state' => 'My State', 'country' => 'USA', 'zip_code' => '12345', 'ref' => 'asdasd', 'join_ip' => '192.168.1.1', 'payvia' => '1', // Check payvia type // notice the structure is an array of sub-arrays that have field/value pairs 'payvia_info' => Array( Array( 'field' => 'Pay To', 'value' => 'Affiliate PayTo Name', ), Array( 'field' => 'Address', 'value' => 'Affiliate Address', ), ), ); $resp = curl_exec($curl); //dumps an associative array representation of the json response $output = json_decode($resp, true); if($output !== NULL) { //json was valid. Dump the decoded array print_r($output); } else { //invalid json, just dump the raw response print_r($resp); } // Close request to clear up some resources curl_close($curl); ?>