NATS5 REST API Adtool PATCH adtool
From TMM Wiki
Revision as of 15:15, 9 August 2019 by TMMJoe (talk | contribs) (TMMJoe moved page NATS4 REST API Adtool PATCH adtool to NATS5 REST API Adtool PATCH adtool: Renaming NATS5 API pages)
PATCH /adtool/adtool
Description
- Edit adtool details
Resource URL
- http://domain/api/adtool/adtool
- Replace domain with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- adtoolid
- type: digit
- required
- adtool_type_id
- type: digit
- required
- adtool
- type: json (JSON Object)
- optional
Example Request
Method: PATCH
URL: http://domain/api/adtool/adtool
Form Data:
- adtoolid: 1
- adtool_type_id: 2
- adtool: {"start_time":"2019-06-10","start_rule":"0","name":"test FHG","url":"http:\/\/www.bing.com","type":"1","items":"5","description":"test 2"}
Response:
{
"success": true,
"result": "adtool updated"
}
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(
'adtoolid' => 1,
'adtool_type_id' => 2,
'adtool' => json_encode(array ( 'start_time' => '2019-06-10', 'start_rule' => '0', 'name' => 'test FHG', 'url' => 'http://www.bing.com', 'type' => '1', 'items' => '5', 'description' => 'test 2',)),
);
$request = Array(
'method' => 'PATCH',
'path' => 'v1/adtool/adtool',
'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);
?>
