Difference between revisions of "NATS4 REST API Add Affiliate"
From TMM Wiki
Jump to navigationJump to searchTmm vincent (talk | contribs) m (updated URL) |
|||
| (3 intermediate revisions by one other user not shown) | |||
| Line 2: | Line 2: | ||
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
| − | == '''POST /affiliate/ | + | == '''POST /affiliate/add''' == |
'''Description''' | '''Description''' | ||
*To add an affiliate through the [[NATS4]] API, you can make a call to this api endpoint. | *To add an affiliate through the [[NATS4]] API, you can make a call to this api endpoint. | ||
'''Resource URL''' | '''Resource URL''' | ||
| − | *<nowiki>http://domain/api | + | *<nowiki>http://domain/api/affiliate/add</nowiki> |
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| Line 88: | Line 88: | ||
'''POST''' | '''POST''' | ||
| − | <nowiki>http://domain/api | + | <nowiki>http://domain/api/affiliate/add</nowiki> |
*Response: | *Response: | ||
| Line 130: | Line 130: | ||
); | ); | ||
| − | $url = 'http://domain/api | + | $url = 'http://domain/api/affiliate/add'; |
$headers = array( | $headers = array( | ||
| − | ' | + | 'api-key: 44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username: tmm1phrvezsbu' |
); | ); | ||
| Line 160: | Line 160: | ||
import requests | import requests | ||
| − | url = 'http://domain/api | + | url = 'http://domain/api/affiliate/add' |
data = { | data = { | ||
| Line 186: | Line 186: | ||
headers = { | headers = { | ||
| − | ' | + | 'api-key': '44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username': 'tmm1phrvezsbu' |
} | } | ||
| Line 223: | Line 223: | ||
} | } | ||
var options = { | var options = { | ||
| − | url: 'http://domain/api | + | url: 'http://domain/api/affiliate/add', |
method: 'POST', | method: 'POST', | ||
| − | form: | + | form: data, |
json: true, | json: true, | ||
headers: { | headers: { | ||
| − | ' | + | 'api-key': '44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username': 'tmm1phrvezsbu' |
} | } | ||
}; | }; | ||
| Line 250: | Line 250: | ||
'''Curl''' | '''Curl''' | ||
<pre> | <pre> | ||
| − | curl -X POST 'http://domain/api | + | curl -X POST 'http://domain/api/affiliate/add' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu" -H "Content-Type: application/x-www-form-urlencoded" -d 'username=apitest2&password=apitest&firstname=Test&lastname=Testakovsky&email=test2%40toomuchmedia.com&company=TMM&url=toomuchmedia.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' |
</pre> | </pre> | ||
Latest revision as of 16:40, 24 May 2018
POST /affiliate/add
Description
- To add an affiliate through the NATS4 API, you can make a call to this api endpoint.
Resource URL
- http://domain/api/affiliate/add
- Replace domain with the nats domain
- POST
Response Format
- JSON
- 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
- password
- type: string
- required
- firstname
- type: string
- required
- lastname
- type: string
- required
- email
- type: string
- required
- company
- type: string
- required
- url
- type: string
- required
- tel
- type: string
- required
- icq
- type: string
- required
- aim
- type: string
- required
- msn
- type: string
- required
- address1
- type: string
- required
- address2
- type: string
- required
- city
- type: string
- required
- state
- type: string
- required
- country
- type: string
- required
- zip_code
- type: string
- required
- tax_id_or_ssn
- type: string
- required
- ref
- type: string
- required
- minimum_payout
- type: string
- required
Example Request
POST
http://domain/api/affiliate/add
- Response:
[
{
"result": true,
"loginid": "10"
}
]
Example Code
PHP
<?php
$curl = curl_init();
$data = array(
'username' => 'hello',
'password' => 'apitest',
'firstname' => 'hello',
'lastname' => 'test',
'email' => 'hello@toomuchmedia.com',
'company' => 'TMM',
'url' => 'toomuchmedia.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,
);
$url = 'http://domain/api/affiliate/add';
$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
?>
Python
- This example requires pip and the request library which can be installed via pip by: 'pip install requests'
import requests
url = 'http://domain/api/affiliate/add'
data = {
'username': 'hello',
'password': 'apitest',
'firstname': 'hello',
'lastname': 'Test',
'email': 'hello@toomuchmedia.com',
'company': 'TMM',
'url': 'toomuchmedia.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,
}
headers = {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'tmm1phrvezsbu'
}
res = requests.post(url, data=data, headers=headers)
print res.json()
node.js
- This example requires npm and the request module which can be installed via npm by: 'npm install request'
var request = require('request');
data = {
'username': 'hello',
'password': 'apitest',
'firstname': 'hello',
'lastname': 'Test',
'email': 'hello@toomuchmedia.com',
'company': 'TMM',
'url': 'toomuchmedia.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,
}
var options = {
url: 'http://domain/api/affiliate/add',
method: 'POST',
form: data,
json: true,
headers: {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'tmm1phrvezsbu'
}
};
function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
else{
console.log(body);
}
}
request(options, callback);
Curl
curl -X POST 'http://domain/api/affiliate/add' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu" -H "Content-Type: application/x-www-form-urlencoded" -d 'username=apitest2&password=apitest&firstname=Test&lastname=Testakovsky&email=test2%40toomuchmedia.com&company=TMM&url=toomuchmedia.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'
