NATS5 REST API Adtool POST adtool-rule
From TMM Wiki
Jump to navigationJump to searchPOST /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 Request
Method: POST
URL: http://domain/api/adtool/adtool-rule
Form Data:
- adtoolid: 1
- rule_type: 1
- login: 1
- program: 1
- site: 1
- tour: 1
- start_time: NOW
- end_time: FOREVER
Response:
{ "success": true, "result": "adtool rule added" }
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_type' => 1, 'login' => '1', 'program' => '1', 'site' => '1', 'tour' => '1', 'start_time' => 'NOW', 'end_time' => 'FOREVER', ); $request = Array( 'method' => 'POST', 'path' => 'v1/adtool/adtool-rule', '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); ?>