NATS5 REST API Service GET rule-info
From TMM Wiki
Jump to navigationJump to searchGET /service/rule-info
Description
- Get the info for building rules
Resource URL
- http://domain/api/service/rule-info
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- type
- type: string
- required
Example Request
Method: GET
URL: http://domain/api/service/rule-info
Query String: type=adtool
Response:
{
"success": true,
"ruleinfo": {
"title": "Adtool",
"key_field": "adtoolid",
"page": "admin_adtools.php",
"page_view": "edit_rule",
"add_action": "add_rule",
"edit_action": "edit_rule",
"disable_action": "disable_rule",
"submit_array": "adtool",
"api": {
"list": "adtool_api\/adtool-rules",
"item": "adtool_api\/adtool-rule",
"add": "adtool_api\/adtool-rule",
"edit": "adtool_api\/adtool-rule",
"delete": "adtool_api\/adtool-rule"
},
"return_array": "adtool_rules",
"return_item": "adtool_rule",
"table": "adtool_rule",
"sql_field": "adtoolid",
"sql_id": "adtool_rule_id",
"simple_fields": [
"login",
"program",
"site"
],
"fields": [
"login",
"program",
"site",
"tour"
],
"rule_types": [
{
"value": 0,
"name": "IGNORE"
},
{
"value": 1,
"name": "SHOW"
},
{
"value": 2,
"name": "HIDE"
}
],
"field_info": {
"login": {
"description": "Affiliates"
},
"program": {
"description": "Programs"
},
"site": {
"description": "Sites"
},
"tour": {
"description": "Tours"
}
}
}
}
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(
'type' => 'adtool',
);
$request = Array(
'method' => 'GET',
'path' => 'v1/service/rule-info',
'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);
?>
