NATS5 REST API Adtool GET adtool
From TMM Wiki
Jump to navigationJump to searchGET /adtool/adtool
Description
- Get adtool details
Resource URL
- http://domain/api/adtool/adtool
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- adtoolid
- type: digit
- required
- adtool_type_id
- type: digit
- optional
- include_type
- type: boolean_digit (0 or 1)
- optional
Example Request
Method: GET
URL: http://domain/api/adtool/adtool
Query String: adtoolid=1&adtool_type_id=2&include_type=1
Response:
{
"success": true,
"adtool": {
"adtoolid": "1",
"networkid": "0",
"name": "test FHG",
"url": "http:\/\/www.google.com",
"type": "1",
"items": "5",
"description": "test",
"thumbnail": "",
"thumb_ext": "",
"deleted": "0",
"model": "",
"published_date": "1555646400",
"ids": [],
"var_divide": "?",
"published_date_nice": "2019-04-19 00:00:00"
},
"adtool_type": {
"adtool_type_id": "2",
"name": "FHG",
"adtool_category_id": "2",
"description": "Free Hosted Galleries",
"orderid": "2",
"deleted": "0",
"switch_db_field": "type",
"disp_tpl": "fhg",
"form_tpl": "fhg",
"protection": "2",
"bulk": "3",
"zip_type": "0",
"short": "fhg",
"adtool_category": "Galleries"
}
}
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,
'include_type' => 1,
);
$request = Array(
'method' => 'GET',
'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);
?>
