Difference between revisions of "NATS5 REST API Adtool GET adtool-rules"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Adtool GET adtool-rules to NATS5 REST API Adtool GET adtool-rules: Renaming NATS5 API pages) |
|||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
== '''GET /adtool/adtool-rules''' == | == '''GET /adtool/adtool-rules''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
| 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 41: | Line 42: | ||
Method: '''GET'''<br/> | Method: '''GET'''<br/> | ||
URL: <nowiki>http://domain/api/adtool/adtool-rules</nowiki><br/> | URL: <nowiki>http://domain/api/adtool/adtool-rules</nowiki><br/> | ||
| − | Query String: <nowiki>adtoolid=1&rule_types%5B0%5D=1&rule_types%5B1%5D=2</nowiki><br/> | + | Query String: <nowiki>adtoolid=1&rule_types%5B0%5D=1&rule_types%5B1%5D=2&login=1&program=1&site=1&tour=1</nowiki><br/> |
Response: | Response: | ||
| Line 48: | Line 49: | ||
"success": true, | "success": true, | ||
"adtool_rules": [ | "adtool_rules": [ | ||
| + | { | ||
| + | "identid": "5", | ||
| + | "start_time": "1565382532", | ||
| + | "end_time": "0", | ||
| + | "rule_type": "1", | ||
| + | "adtoolid": "ALL", | ||
| + | "start_nice": "2019-08-09 16:28:52", | ||
| + | "end_nice": "FOREVER", | ||
| + | "rule_status": 1, | ||
| + | "advanced": 1, | ||
| + | "override_identifier_id": [ | ||
| + | "5" | ||
| + | ], | ||
| + | "ruleid": "1565382532:0:1", | ||
| + | "affiliate": { | ||
| + | "productsupport": "productsupport" | ||
| + | }, | ||
| + | "rule_type_nice": "SHOW", | ||
| + | "login": [ | ||
| + | { | ||
| + | "id": "1", | ||
| + | "name": "productsupport" | ||
| + | } | ||
| + | ], | ||
| + | "program": [ | ||
| + | { | ||
| + | "id": "1", | ||
| + | "name": "50% Revshare" | ||
| + | } | ||
| + | ], | ||
| + | "site": [ | ||
| + | { | ||
| + | "id": "1", | ||
| + | "name": "Membership Site A" | ||
| + | } | ||
| + | ], | ||
| + | "tour": [ | ||
| + | { | ||
| + | "id": "1", | ||
| + | "name": "(member_a) Default Tour" | ||
| + | } | ||
| + | ] | ||
| + | }, | ||
{ | { | ||
"identid": "1", | "identid": "1", | ||
| Line 113: | Line 157: | ||
1 => 2, | 1 => 2, | ||
), | ), | ||
| + | 'login' => '1', | ||
| + | 'program' => '1', | ||
| + | 'site' => '1', | ||
| + | 'tour' => '1', | ||
); | ); | ||
| Line 154: | Line 202: | ||
</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 --> | ||
Revision as of 15:42, 9 August 2019
GET /adtool/adtool-rules
Description
Resource URL
- http://domain/api/adtool/adtool-rules
- 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
- rule_types
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional (default value: Array)
- login
- optional
- program
- optional
- site
- optional
- tour
- optional
- text_search
- optional
Example Request
Method: GET
URL: http://domain/api/adtool/adtool-rules
Query String: adtoolid=1&rule_types%5B0%5D=1&rule_types%5B1%5D=2&login=1&program=1&site=1&tour=1
Response:
{
"success": true,
"adtool_rules": [
{
"identid": "5",
"start_time": "1565382532",
"end_time": "0",
"rule_type": "1",
"adtoolid": "ALL",
"start_nice": "2019-08-09 16:28:52",
"end_nice": "FOREVER",
"rule_status": 1,
"advanced": 1,
"override_identifier_id": [
"5"
],
"ruleid": "1565382532:0:1",
"affiliate": {
"productsupport": "productsupport"
},
"rule_type_nice": "SHOW",
"login": [
{
"id": "1",
"name": "productsupport"
}
],
"program": [
{
"id": "1",
"name": "50% Revshare"
}
],
"site": [
{
"id": "1",
"name": "Membership Site A"
}
],
"tour": [
{
"id": "1",
"name": "(member_a) Default Tour"
}
]
},
{
"identid": "1",
"start_time": "1555646400",
"end_time": "0",
"rule_type": "1",
"adtoolid": "ALL",
"start_nice": "2019-04-19 00:00:00",
"end_nice": "FOREVER",
"rule_status": 1,
"advanced": 1,
"override_identifier_id": [
"1"
],
"ruleid": "1555646400:0:1",
"rule_type_nice": "SHOW",
"login": [
{
"id": 0,
"name": "ALL"
}
],
"program": [
{
"id": 0,
"name": "ALL"
}
],
"site": [
{
"id": 0,
"name": "ALL"
}
],
"tour": [
{
"id": 0,
"name": "ALL"
}
]
}
]
}
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,
'rule_types' => array (
0 => 1,
1 => 2,
),
'login' => '1',
'program' => '1',
'site' => '1',
'tour' => '1',
);
$request = Array(
'method' => 'GET',
'path' => 'v1/adtool/adtool-rules',
'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);
?>
