Difference between revisions of "NATS5 REST API Adtool POST category"
From TMM Wiki
Jump to navigationJump to search| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_adtool_section = true |
}} | }} | ||
== '''POST /adtool/category''' == | == '''POST /adtool/category''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Add new adtool type category | * Add new adtool type category | ||
| 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 28: | Line 29: | ||
** optional | ** optional | ||
| + | == '''Example Request''' == | ||
| + | Method: '''POST'''<br/> | ||
| + | URL: <nowiki>http://domain/api/adtool/category</nowiki><br/> | ||
| + | Form Data:<br/> | ||
| + | * name: testCategory | ||
| + | * description: test category addition | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "success": true, | ||
| + | "result": "adtool category added", | ||
| + | "category": { | ||
| + | "adtool_category_id": "1000", | ||
| + | "name": "testCategory", | ||
| + | "description": "test category addition", | ||
| + | "orderid": "9", | ||
| + | "deleted": "0", | ||
| + | "protection": "0" | ||
| + | } | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
== '''Example Code''' == | == '''Example Code''' == | ||
| Line 35: | Line 61: | ||
<?php | <?php | ||
| − | + | $headers = array( //set your username and API key here | |
| − | + | 'api-key: 44b5498dbcb481a0d00b404c0169af62', | |
| − | $headers = array( | + | 'api-username: tmm1phrvezsbu' |
| − | |||
| − | |||
); | ); | ||
| + | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| − | $data = | + | $data = Array( |
| − | + | 'name' => 'testCategory', | |
| + | 'description' => 'test category addition', | ||
); | ); | ||
| Line 52: | Line 78: | ||
); | ); | ||
| − | $url = ' | + | /*code below is the same for (almost) every API call */ |
| + | |||
| + | $curl = curl_init(); | ||
| + | |||
| + | $url = $url.'/api/'.$request['path']; | ||
$query = http_build_query($request['data']); | $query = http_build_query($request['data']); | ||
if($request['method'] == 'GET'){ | if($request['method'] == 'GET'){ | ||
| − | $url = $url.'?'.$query; | + | //add query string parameters to the end of the url |
| + | $url = $url.'?'.$query; | ||
}else{ | }else{ | ||
| + | //send parameters as POST fields | ||
curl_setopt($curl, CURLOPT_POST, 1); | curl_setopt($curl, CURLOPT_POST, 1); | ||
| − | curl_setopt($curl, CURLOPT_POSTFIELDS, $query); | + | curl_setopt($curl, CURLOPT_POSTFIELDS, $query); |
| + | |||
if($request['method'] != 'POST'){ | if($request['method'] != 'POST'){ | ||
$headers[] ='X-HTTP-Method: '.$request['method']; //send custom request method | $headers[] ='X-HTTP-Method: '.$request['method']; //send custom request method | ||
| Line 78: | Line 111: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_adtool_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 --> | ||
Latest revision as of 15:57, 9 August 2019
POST /adtool/category
Description
- Add new adtool type category
Resource URL
- http://domain/api/adtool/category
- 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
- description
- type: string
- optional
Example Request
Method: POST
URL: http://domain/api/adtool/category
Form Data:
- name: testCategory
- description: test category addition
Response:
{
"success": true,
"result": "adtool category added",
"category": {
"adtool_category_id": "1000",
"name": "testCategory",
"description": "test category addition",
"orderid": "9",
"deleted": "0",
"protection": "0"
}
}
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' => 'testCategory',
'description' => 'test category addition',
);
$request = Array(
'method' => 'POST',
'path' => 'v1/adtool/category',
'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);
?>
