Difference between revisions of "NATS5 REST API Adtool GET search"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Adtool GET search to NATS5 REST API Adtool GET search: Renaming NATS5 API pages) |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_adtool_section = true |
}} | }} | ||
== '''GET /adtool/search''' == | == '''GET /adtool/search''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Search for adtools of a specific type | * Search for adtools of a specific type | ||
| Line 9: | Line 10: | ||
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']] |
*GET | *GET | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 51: | Line 52: | ||
Method: '''GET'''<br/> | Method: '''GET'''<br/> | ||
URL: <nowiki>http://domain/api/adtool/search</nowiki><br/> | URL: <nowiki>http://domain/api/adtool/search</nowiki><br/> | ||
| − | Query String: <nowiki>adtool_type_id=2</nowiki><br/> | + | Query String: <nowiki>adtool_type_id=2&loginid=1&campaignid=1&programid=1&siteid=1&tourid=1&start=NOW&count=1000</nowiki><br/> |
Response: | Response: | ||
<pre> | <pre> | ||
[ | [ | ||
| + | { | ||
| + | "adtoolid": "1", | ||
| + | "name": "test FHG", | ||
| + | "url": "http:\/\/www.google.com", | ||
| + | "published_date": "1565382532", | ||
| + | "trackurl": "http:\/\/root.nats4.com\/gallery\/MS4xLjEuMS4xLjEuMC4wLjA", | ||
| + | "natscode": "MS4xLjEuMS4xLjEuMC4wLjA", | ||
| + | "extra": { | ||
| + | "identid": "5", | ||
| + | "siteid": "1", | ||
| + | "networkid": "0", | ||
| + | "type": "1", | ||
| + | "items": "5", | ||
| + | "description": "test", | ||
| + | "thumbnail": "", | ||
| + | "thumb_ext": "", | ||
| + | "deleted": "0", | ||
| + | "model": "", | ||
| + | "ids": { | ||
| + | "loginid": 1, | ||
| + | "programid": 1, | ||
| + | "siteid": "1", | ||
| + | "tourid": 1, | ||
| + | "campaignid": 1, | ||
| + | "siteids": [ | ||
| + | "1" | ||
| + | ] | ||
| + | }, | ||
| + | "var_divide": "?", | ||
| + | "ident_details": { | ||
| + | "override_identifier_id": "5", | ||
| + | "loginid": "1", | ||
| + | "networkid": "0", | ||
| + | "programid": "1", | ||
| + | "siteid": "1", | ||
| + | "tourid": "1", | ||
| + | "optionid": "0", | ||
| + | "adtoolid": "0", | ||
| + | "subid1": "0", | ||
| + | "subid2": "0", | ||
| + | "billerid": "0", | ||
| + | "countryid": "000", | ||
| + | "promotionalid": "0" | ||
| + | }, | ||
| + | "published_date_nice": "2019-08-09 16:28:52" | ||
| + | } | ||
| + | }, | ||
{ | { | ||
"adtoolid": "1", | "adtoolid": "1", | ||
| Line 61: | Line 109: | ||
"url": "http:\/\/www.google.com", | "url": "http:\/\/www.google.com", | ||
"published_date": "1555646400", | "published_date": "1555646400", | ||
| − | "trackurl": "http:\/\/ | + | "trackurl": "http:\/\/root.nats4.com\/gallery\/MS4xLjEuMS4xLjEuMC4wLjA", |
| − | "natscode": " | + | "natscode": "MS4xLjEuMS4xLjEuMC4wLjA", |
"extra": { | "extra": { | ||
"identid": "1", | "identid": "1", | ||
| Line 75: | Line 123: | ||
"model": "", | "model": "", | ||
"ids": { | "ids": { | ||
| − | "loginid": | + | "loginid": 1, |
| − | "programid": | + | "programid": 1, |
"siteid": "1", | "siteid": "1", | ||
| − | "tourid": | + | "tourid": 1, |
| − | "campaignid": | + | "campaignid": 1, |
"siteids": [ | "siteids": [ | ||
"1" | "1" | ||
| Line 123: | Line 171: | ||
$data = Array( | $data = Array( | ||
'adtool_type_id' => 2, | 'adtool_type_id' => 2, | ||
| + | 'loginid' => 1, | ||
| + | 'campaignid' => 1, | ||
| + | 'programid' => 1, | ||
| + | 'siteid' => 1, | ||
| + | 'tourid' => 1, | ||
| + | 'start' => 'NOW', | ||
| + | 'count' => 1000, | ||
); | ); | ||
| Line 164: | Line 219: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_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 --> | [[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | ||
Latest revision as of 15:57, 9 August 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&loginid=1&campaignid=1&programid=1&siteid=1&tourid=1&start=NOW&count=1000
Response:
[
{
"adtoolid": "1",
"name": "test FHG",
"url": "http:\/\/www.google.com",
"published_date": "1565382532",
"trackurl": "http:\/\/root.nats4.com\/gallery\/MS4xLjEuMS4xLjEuMC4wLjA",
"natscode": "MS4xLjEuMS4xLjEuMC4wLjA",
"extra": {
"identid": "5",
"siteid": "1",
"networkid": "0",
"type": "1",
"items": "5",
"description": "test",
"thumbnail": "",
"thumb_ext": "",
"deleted": "0",
"model": "",
"ids": {
"loginid": 1,
"programid": 1,
"siteid": "1",
"tourid": 1,
"campaignid": 1,
"siteids": [
"1"
]
},
"var_divide": "?",
"ident_details": {
"override_identifier_id": "5",
"loginid": "1",
"networkid": "0",
"programid": "1",
"siteid": "1",
"tourid": "1",
"optionid": "0",
"adtoolid": "0",
"subid1": "0",
"subid2": "0",
"billerid": "0",
"countryid": "000",
"promotionalid": "0"
},
"published_date_nice": "2019-08-09 16:28:52"
}
},
{
"adtoolid": "1",
"name": "test FHG",
"url": "http:\/\/www.google.com",
"published_date": "1555646400",
"trackurl": "http:\/\/root.nats4.com\/gallery\/MS4xLjEuMS4xLjEuMC4wLjA",
"natscode": "MS4xLjEuMS4xLjEuMC4wLjA",
"extra": {
"identid": "1",
"siteid": "0",
"networkid": "0",
"type": "1",
"items": "5",
"description": "test",
"thumbnail": "",
"thumb_ext": "",
"deleted": "0",
"model": "",
"ids": {
"loginid": 1,
"programid": 1,
"siteid": "1",
"tourid": 1,
"campaignid": 1,
"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,
'loginid' => 1,
'campaignid' => 1,
'programid' => 1,
'siteid' => 1,
'tourid' => 1,
'start' => 'NOW',
'count' => 1000,
);
$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);
?>
