Difference between revisions of "NATS5 REST API Adtool POST group"
From TMM Wiki
Jump to navigationJump to search| Line 28: | Line 28: | ||
** optional | ** optional | ||
| + | == '''Example Request''' == | ||
| + | Method: '''POST'''<br/> | ||
| + | URL: <nowiki>http://domain/api/adtool/group</nowiki><br/> | ||
| + | Form Data:<br/> | ||
| + | * name: 12 | ||
| + | * parentid: 0 | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "success": true, | ||
| + | "result": "adtool group added", | ||
| + | "group": { | ||
| + | "adtool_group_id": "1000", | ||
| + | "name": "12", | ||
| + | "parentid": "0" | ||
| + | } | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
== '''Example Code''' == | == '''Example Code''' == | ||
| Line 41: | Line 63: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| − | $data = | + | $data = Array( |
| − | + | 'name' => '12', | |
| + | 'parentid' => 0, | ||
); | ); | ||
Revision as of 16:07, 19 April 2019
POST /adtool/group
Description
- Add new adtools group
Resource URL
- http://domain/api/adtool/group
- 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
- parentid
- type: digit
- optional
Example Request
Method: POST
URL: http://domain/api/adtool/group
Form Data:
- name: 12
- parentid: 0
Response:
{
"success": true,
"result": "adtool group added",
"group": {
"adtool_group_id": "1000",
"name": "12",
"parentid": "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' => '12',
'parentid' => 0,
);
$request = Array(
'method' => 'POST',
'path' => 'v1/adtool/group',
'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);
?>
