Difference between revisions of "NATS4 REST API Get Affiliate Payout"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS4 Manual | show_api_admin_section = true }} == '''GET affiliate/payout''' == '''Description''' *NATS4 supports an API resource to get affiliate payout data for a sp...") |
|||
| (2 intermediate revisions by one other user not shown) | |||
| Line 7: | Line 7: | ||
'''Resource URL''' | '''Resource URL''' | ||
| − | *<nowiki>http://domain/api | + | *<nowiki>http://domain/api/affiliate/payout</nowiki> |
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| Line 43: | Line 43: | ||
'''GET''' | '''GET''' | ||
| − | <nowiki>http://domain/api | + | <nowiki>http://domain/api/affiliate/payout</nowiki> |
*Response: | *Response: | ||
| Line 63: | Line 63: | ||
'loginid' => 1, | 'loginid' => 1, | ||
'siteid' => 1, | 'siteid' => 1, | ||
| − | ' | + | 'start_date' => '2006-06-06', |
| − | ' | + | 'end_date' => '2015-03-14' |
); | ); | ||
$data_string = http_build_query($data); | $data_string = http_build_query($data); | ||
| − | $url = 'http://domain/api | + | $url = 'http://domain/api/affiliate/payout?'.$data_string; |
$headers = array( | $headers = array( | ||
| − | ' | + | 'api-key: 44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username: tmm1phrvezsbu' |
); | ); | ||
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); | curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); | ||
| Line 93: | Line 93: | ||
import requests | import requests | ||
| − | url = 'http://domain/api | + | url = 'http://domain/api/affiliate/payout' |
params = { | params = { | ||
'loginid': 1, | 'loginid': 1, | ||
'siteid': 1, | 'siteid': 1, | ||
| − | ' | + | 'start_date': '2006-06-06', |
| − | ' | + | 'end_date': '2015-03-14' |
} | } | ||
headers = { | headers = { | ||
| − | ' | + | 'api-key': '44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username': 'tmm1phrvezsbu' |
} | } | ||
| Line 120: | Line 120: | ||
var options = { | var options = { | ||
| − | url: 'http://domain/api | + | url: 'http://domain/api/affiliate/payout', |
method: 'GET', | method: 'GET', | ||
qs: { | qs: { | ||
'loginid': 1, | 'loginid': 1, | ||
'siteid': 1, | 'siteid': 1, | ||
| − | ' | + | 'start_date': '2006-06-06', |
| − | ' | + | 'end_date': '2015-03-14' |
}, | }, | ||
json: true, | json: true, | ||
headers: { | headers: { | ||
| − | ' | + | 'api-key': '44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username': 'tmm1phrvezsbu' |
} | } | ||
}; | }; | ||
| Line 152: | Line 152: | ||
'''Curl''' | '''Curl''' | ||
<pre> | <pre> | ||
| − | curl -X GET 'http://domain/api | + | curl -X GET 'http://domain/api/affiliate/payout?loginid=1&siteid=1&start_date=2006-06-06&end_date=2015-03-14' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu" |
</pre> | </pre> | ||
[[Category:NATS4 API Articles]] | [[Category:NATS4 API Articles]] | ||
Latest revision as of 13:32, 17 August 2017
GET affiliate/payout
Description
- NATS4 supports an API resource to get affiliate payout data for a specific time frame. You can choose a specific site or receive the payout data back for all of the sites.
Resource URL
- http://domain/api/affiliate/payout
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Paremeters can be sent as url encoded params..
- loginid: The affiliate ID. This parameter is required.
- type: integer
- required
- siteid: The siteid you wish to grab payout data for. If not supplied, NATS will grab payout data for all sites.
- type: integer
- optional
- startDate: The beginning date for the data you wish to see. Date will be parsed by the PHP strtotime function. A valid date can be YYYY-MM-DD.
- type: string
- optional
- endDate: The ending date for the data you wish to see. Date will be parsed by the PHP strtotime function. A valid date can be YYYY-MM-DD.
- type: string
- optional
Example Request
GET
http://domain/api/affiliate/payout
- Response:
{
"earned": 666,
"stored": 666
}
Example Code
PHP
<?php
$curl = curl_init();
$data = array(
'loginid' => 1,
'siteid' => 1,
'start_date' => '2006-06-06',
'end_date' => '2015-03-14'
);
$data_string = http_build_query($data);
$url = 'http://domain/api/affiliate/payout?'.$data_string;
$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);
$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/payout'
params = {
'loginid': 1,
'siteid': 1,
'start_date': '2006-06-06',
'end_date': '2015-03-14'
}
headers = {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'tmm1phrvezsbu'
}
res = requests.get(url, params=params, 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');
var options = {
url: 'http://domain/api/affiliate/payout',
method: 'GET',
qs: {
'loginid': 1,
'siteid': 1,
'start_date': '2006-06-06',
'end_date': '2015-03-14'
},
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 GET 'http://domain/api/affiliate/payout?loginid=1&siteid=1&start_date=2006-06-06&end_date=2015-03-14' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu"
