Difference between revisions of "NATS5 REST API Reward GET points"
From TMM Wiki
Jump to navigationJump to search| Line 1: | Line 1: | ||
{{NATS5 Manual | {{NATS5 Manual | ||
| − | | | + | | show_api_admin_reward_section = true |
}} | }} | ||
== '''GET /reward/points''' == | == '''GET /reward/points''' == | ||
Latest revision as of 16:01, 9 August 2019
GET /reward/points
Description
- Get point payouts
Resource URL
- http://domain/api/reward/points
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
None
Example Request
Method: GET
URL: http://domain/api/reward/points
Response:
{
"success": true,
"points": [
{
"change_order": 2,
"payout": [
{
"fieldid": 0,
"name": "Raw",
"bonus": "10"
},
{
"fieldid": 1,
"name": "Unique",
"bonus": "20"
},
{
"fieldid": 2,
"name": "Initial",
"bonus": "30"
},
{
"fieldid": 3,
"name": "Rebill",
"bonus": "100"
},
{
"fieldid": 4,
"name": "Refund",
"bonus": "200"
}
],
"start_time": "1565382570",
"change_type": "1",
"change_type_nice": "Standard Change",
"start_time_nice": "2019-08-09 16:29:30",
"end_time": "0",
"end_time_nice": "Never",
"affiliates": [
{
"loginid": 2,
"username": "tmmvaffiliate"
}
],
"sites": [],
"programs": []
},
{
"change_order": 1,
"payout": [
{
"fieldid": 0,
"name": "Raw",
"bonus": "1"
},
{
"fieldid": 1,
"name": "Unique",
"bonus": "2"
},
{
"fieldid": 2,
"name": "Initial",
"bonus": "3"
},
{
"fieldid": 3,
"name": "Rebill",
"bonus": "10"
},
{
"fieldid": 4,
"name": "Refund",
"bonus": "20"
}
],
"start_time": "1565382570",
"change_type": "1",
"change_type_nice": "Standard Change",
"start_time_nice": "2019-08-09 16:29:30",
"end_time": "0",
"end_time_nice": "Never",
"affiliates": [
{
"loginid": 1,
"username": "productsupport"
}
],
"sites": [],
"programs": []
}
]
}
Example Code
PHP
<?php
$headers = array( //set your username and API key here
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
$url = 'http://yourdomain.com'; //set your NATS URL here
$data = array();
$request = Array(
'method' => 'GET',
'path' => 'v1/reward/points',
'data' => $data
);
/*code below is the same for (almost) every API call */
$curl = curl_init();
$url = $url.'/api/'.$request['path'];
$query = http_build_query($request['data']);
if($request['method'] == 'GET'){
//add query string parameters to the end of the url
$url = $url.'?'.$query;
}else{
//send parameters as POST fields
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, $query);
if($request['method'] != 'POST'){
$headers[] ='X-HTTP-Method: '.$request['method']; //send custom request method
}
}
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$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);
?>
