/api/adtool/adtool

get

Get adtool details

Authorizations

api-key & api-username

api-keystringRequired

api-usernamestringRequired

Query parameters

adtoolidintegerRequired

adtool_type_idintegerOptional

include_typestringOptional

Responses

200

success

text/phpapplication/jsonapplication/xml

successbooleanOptionalExample: true

get

/api/adtool/adtool

PHP (cURL)

<?php

$headers = array( //set your username and API key here
	'api-key: 44b5498dbcb481a0d00b404c0169af62',
	'api-username: tmm1phrvezsbu'
);
$url = 'https://yourdomain.com'; //set your NATS URL here

$data = array(
		'adtoolid' => 1,
		'adtool_type_id' => 2,
		'include_type' => 1
	);

$request = array(
	'method' => 'GET',
	'path' => '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);
?>

200

success

{
  "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"
  }
}

post

Add adtool

Authorizations

api-key & api-username

api-keystringRequired

api-usernamestringRequired

Query parameters

adtool_type_idintegerRequired

adtoolstringOptional

Responses

200

success

text/phpapplication/jsonapplication/xml

successbooleanOptionalExample: true

post

/api/adtool/adtool

PHP (cURL)

<?php

$headers = array( //set your username and API key here
	'api-key: 44b5498dbcb481a0d00b404c0169af62',
	'api-username: tmm1phrvezsbu'
);
$url = 'https://yourdomain.com'; //set your NATS URL here

$data = array(
		'adtool_type_id' => 2,
		'adtool' => json_encode(array ( 'start_time' => '2019-04-19', 'start_rule' => '0', 'name' => 'test FHG', 'url' => 'http://www.google.com', 'type' => '1', 'items' => '5', 'description' => 'test',))
	);

$request = array(
	'method' => 'POST',
	'path' => '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);
?>

200

success

{
  "success": true,
  "result": "adtool added",
  "adtoolid": 1
}

delete

Delete adtool

Authorizations

api-key & api-username

api-keystringRequired

api-usernamestringRequired

Query parameters

adtoolidstringRequired

adtool_type_idintegerRequired

Responses

200

success

text/phpapplication/jsonapplication/xml

successbooleanOptionalExample: true

delete

/api/adtool/adtool

PHP (cURL)

<?php

$headers = array( //set your username and API key here
	'api-key: 44b5498dbcb481a0d00b404c0169af62',
	'api-username: tmm1phrvezsbu'
);
$url = 'https://yourdomain.com'; //set your NATS URL here

$data = array(
		'adtoolid' => 1,
		'adtool_type_id' => 2
	);

$request = array(
	'method' => 'DELETE',
	'path' => '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);
?>

200

success

{
  "success": true,
  "result": "Adtool deleted"
}

patch

Edit adtool details

Authorizations

api-key & api-username

api-keystringRequired

api-usernamestringRequired

Query parameters

adtoolidintegerRequired

adtool_type_idintegerRequired

adtoolstringOptional

Responses

200

success

text/phpapplication/jsonapplication/xml

successbooleanOptionalExample: true

patch

/api/adtool/adtool

PHP (cURL)

<?php

$headers = array( //set your username and API key here
	'api-key: 44b5498dbcb481a0d00b404c0169af62',
	'api-username: tmm1phrvezsbu'
);
$url = 'https://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' => '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);
?>

200

success

{
  "success": true,
  "result": "adtool updated"
}