Difference between revisions of "NATS5 REST API Adtool GET search"
From TMM Wiki
Jump to navigationJump to search| Line 58: | Line 58: | ||
{ | { | ||
"adtoolid": "1", | "adtoolid": "1", | ||
| − | "name": "test", | + | "name": "test FHG", |
| − | "url": "http:\/\/google.com", | + | "url": "http:\/\/www.google.com", |
"published_date": "1555646400", | "published_date": "1555646400", | ||
| − | "trackurl": "http:\/\/ | + | "trackurl": "http:\/\/democash.com\/gallery\/MC4wLjAuMC4wLjEuMC4wLjA", |
"natscode": "MC4wLjAuMC4wLjEuMC4wLjA", | "natscode": "MC4wLjAuMC4wLjEuMC4wLjA", | ||
"extra": { | "extra": { | ||
| Line 68: | Line 68: | ||
"networkid": "0", | "networkid": "0", | ||
"type": "1", | "type": "1", | ||
| − | "items": " | + | "items": "5", |
| − | "description": " | + | "description": "test", |
"thumbnail": "", | "thumbnail": "", | ||
"thumb_ext": "", | "thumb_ext": "", | ||
| Line 81: | Line 81: | ||
"campaignid": 0, | "campaignid": 0, | ||
"siteids": [ | "siteids": [ | ||
| − | "1 | + | "1" |
| − | |||
] | ] | ||
}, | }, | ||
| Line 168: | Line 167: | ||
[[Category:NATS4_REST_adtool_Collection]] | [[Category:NATS4_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 --> | ||
Revision as of 13:25, 7 June 2019
GET /adtool/search
Description
- Search for adtools of a specific type
Resource URL
- http://domain/api/adtool/search
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- adtool_type_id
- required
- loginid
- optional
- campaignid
- optional
- programid
- optional
- siteid
- optional
- tourid
- optional
- start
- optional
- count
- optional
- order
- optional
- time
- optional
- time_setting
- optional
- search
- optional
- banner
- optional
Example Request
Method: GET
URL: http://domain/api/adtool/search
Query String: adtool_type_id=2
Response:
[
{
"adtoolid": "1",
"name": "test FHG",
"url": "http:\/\/www.google.com",
"published_date": "1555646400",
"trackurl": "http:\/\/democash.com\/gallery\/MC4wLjAuMC4wLjEuMC4wLjA",
"natscode": "MC4wLjAuMC4wLjEuMC4wLjA",
"extra": {
"identid": "1",
"siteid": "0",
"networkid": "0",
"type": "1",
"items": "5",
"description": "test",
"thumbnail": "",
"thumb_ext": "",
"deleted": "0",
"model": "",
"ids": {
"loginid": 0,
"programid": 0,
"siteid": "1",
"tourid": 0,
"campaignid": 0,
"siteids": [
"1"
]
},
"var_divide": "?",
"ident_details": {
"override_identifier_id": "1",
"loginid": "0",
"networkid": "0",
"programid": "0",
"siteid": "0",
"tourid": "0",
"optionid": "0",
"adtoolid": "0",
"subid1": "0",
"subid2": "0",
"billerid": "0",
"countryid": "000",
"promotionalid": "0"
},
"published_date_nice": "2019-04-19 00:00:00"
}
}
]
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(
'adtool_type_id' => 2,
);
$request = Array(
'method' => 'GET',
'path' => 'v1/adtool/search',
'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);
?>
