Difference between revisions of "NATS5 REST API Reward GET points"
From TMM Wiki
Jump to navigationJump to search(2 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | {{ | + | {{NATS5 Manual |
− | | | + | | show_api_admin_reward_section = true |
}} | }} | ||
== '''GET /reward/points''' == | == '''GET /reward/points''' == | ||
+ | |||
'''Description''' | '''Description''' | ||
* Get point payouts | * Get point payouts | ||
Line 9: | Line 10: | ||
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
− | '''[[ | + | '''[[NATS5_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']] |
*GET | *GET | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
− | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
Line 29: | Line 30: | ||
"success": true, | "success": true, | ||
"points": [ | "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, | "change_order": 1, | ||
Line 35: | Line 80: | ||
"fieldid": 0, | "fieldid": 0, | ||
"name": "Raw", | "name": "Raw", | ||
− | "bonus": " | + | "bonus": "1" |
}, | }, | ||
{ | { | ||
"fieldid": 1, | "fieldid": 1, | ||
"name": "Unique", | "name": "Unique", | ||
− | "bonus": " | + | "bonus": "2" |
}, | }, | ||
{ | { | ||
"fieldid": 2, | "fieldid": 2, | ||
"name": "Initial", | "name": "Initial", | ||
− | "bonus": " | + | "bonus": "3" |
}, | }, | ||
{ | { | ||
"fieldid": 3, | "fieldid": 3, | ||
"name": "Rebill", | "name": "Rebill", | ||
− | "bonus": " | + | "bonus": "10" |
}, | }, | ||
{ | { | ||
"fieldid": 4, | "fieldid": 4, | ||
"name": "Refund", | "name": "Refund", | ||
− | "bonus": " | + | "bonus": "20" |
} | } | ||
], | ], | ||
− | "start_time": " | + | "start_time": "1565382570", |
"change_type": "1", | "change_type": "1", | ||
"change_type_nice": "Standard Change", | "change_type_nice": "Standard Change", | ||
− | "start_time_nice": "2019- | + | "start_time_nice": "2019-08-09 16:29:30", |
"end_time": "0", | "end_time": "0", | ||
"end_time_nice": "Never", | "end_time_nice": "Never", | ||
Line 133: | Line 178: | ||
</pre> | </pre> | ||
− | [[Category: | + | [[Category:NATS5_REST_APIs]] |
− | [[Category: | + | [[Category:NATS5_REST_reward_Collection]] |
[[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | [[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | ||
[[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | [[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> |
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); ?>