NATS5 REST API Reward POST reward
From TMM Wiki
(Redirected from NATS4 REST API Reward POST reward)
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 /reward/reward
Description
- Add new reward
Resource URL
- http://domain/api/reward/reward
- Replace domain with the nats domain
- POST
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- name
- type: string
- required
- reward_category_id
- type: digit
- required
- description
- type: string
- optional
- cost
- type: digit
- required
- url
- type: string
- optional
Example Request
Method: POST
URL: http://domain/api/reward/reward
Form Data:
- name: test reward
- reward_category_id: 1
- cost: 20
- description: test reward description
Response:
{ "success": true, "result": "Reward added", "reward": { "rewardid": "1", "reward_category_id": "1", "cost": "20", "name": "test reward", "url": "", "description": "test reward description", "deleted": "0", "thumb_ext": "" } }
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( 'name' => 'test reward', 'reward_category_id' => '1', 'cost' => 20, 'description' => 'test reward description', ); $request = Array( 'method' => 'POST', 'path' => 'v1/reward/reward', '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); ?>