Difference between revisions of "NATS5 REST API Reward POST reward"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Reward POST reward to NATS5 REST API Reward POST reward: Renaming NATS5 API pages) |
|||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
== '''POST /reward/reward''' == | == '''POST /reward/reward''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Add new reward | * Add new reward | ||
| 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''']] |
*POST | *POST | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 44: | Line 45: | ||
* reward_category_id: 1 | * reward_category_id: 1 | ||
* cost: 20 | * cost: 20 | ||
| + | * description: test reward description | ||
Response: | Response: | ||
| Line 56: | Line 58: | ||
"name": "test reward", | "name": "test reward", | ||
"url": "", | "url": "", | ||
| − | "description": | + | "description": "test reward description", |
"deleted": "0", | "deleted": "0", | ||
"thumb_ext": "" | "thumb_ext": "" | ||
| Line 82: | Line 84: | ||
'reward_category_id' => '1', | 'reward_category_id' => '1', | ||
'cost' => 20, | 'cost' => 20, | ||
| + | 'description' => 'test reward description', | ||
); | ); | ||
| Line 123: | Line 126: | ||
</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 --> | ||
Revision as of 15:46, 9 August 2019
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);
?>
