Difference between revisions of "NATS5 REST API Adtool POST adtool-rule"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS4 Manual | show_api_admin_section = true }} == '''POST /adtool/adtool-rule''' == '''Description''' * Add new adtool rule '''Resource URL''' *<nowiki>http://domain/api/...") |
|||
| Line 45: | Line 45: | ||
** type: string | ** type: string | ||
** optional (default value: FOREVER) | ** optional (default value: FOREVER) | ||
| + | |||
| + | |||
| + | == '''Example Code''' == | ||
| + | |||
| + | '''PHP''' | ||
| + | <pre> | ||
| + | <?php | ||
| + | |||
| + | $curl = curl_init(); | ||
| + | |||
| + | $headers = array( | ||
| + | 'api-key: 44b5498dbcb481a0d00b404c0169af62', | ||
| + | 'api-username: tmm1phrvezsbu' | ||
| + | ); | ||
| + | |||
| + | $data = array( | ||
| + | /* Add API parameters here */ | ||
| + | ); | ||
| + | |||
| + | $request = Array( | ||
| + | 'method' => 'POST', | ||
| + | 'path' => 'v1/adtool/adtool-rule', | ||
| + | 'data' => $data | ||
| + | ); | ||
| + | |||
| + | $url = 'http://domain/api/'.$request['path']; | ||
| + | |||
| + | $query = http_build_query($request['data']); | ||
| + | |||
| + | if($request['method'] == 'GET'){ | ||
| + | $url = $url.'?'.$query; //add query string parameters to the end of the url | ||
| + | }else{ | ||
| + | curl_setopt($curl, CURLOPT_POST, 1); | ||
| + | curl_setopt($curl, CURLOPT_POSTFIELDS, $query); //send parameters as POST fields | ||
| + | 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); | ||
| + | ?> | ||
| + | </pre> | ||
[[Category:NATS4_REST_APIs]] | [[Category:NATS4_REST_APIs]] | ||
[[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 --> | ||
Revision as of 11:11, 19 April 2019
POST /adtool/adtool-rule
Description
- Add new adtool rule
Resource URL
- http://domain/api/adtool/adtool-rule
- Replace domain with the nats domain
- POST
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- adtoolid
- type: digit
- required
- rule_type
- type: trinary_digit (0, 1, or 2)
- required
- login
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional
- program
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional
- site
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional
- tour
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional
- start_time
- type: string
- optional (default value: NOW)
- end_time
- type: string
- optional (default value: FOREVER)
Example Code
PHP
<?php
$curl = curl_init();
$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
$data = array(
/* Add API parameters here */
);
$request = Array(
'method' => 'POST',
'path' => 'v1/adtool/adtool-rule',
'data' => $data
);
$url = 'http://domain/api/'.$request['path'];
$query = http_build_query($request['data']);
if($request['method'] == 'GET'){
$url = $url.'?'.$query; //add query string parameters to the end of the url
}else{
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, $query); //send parameters as POST fields
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);
?>
