NATS5 REST API Affiliate GET campaigns
From TMM Wiki
Jump to navigationJump to searchGET /affiliate/campaigns
Note: This is an autogenerated wiki page for the NATS5 API. There may be additional descriptions or examples available on the NATS 4 API wiki for this API.
Description
- Get campaigns for a specific affiliate
Resource URL
- http://domain/api/affiliate/campaigns
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- loginid
- required
- campaignid
- type: digit
- optional
- start
- type: digit
- optional
- count
- type: digit
- optional
- orderby
- optional (default value: name)
- as_array
- type: boolean_digit (0 or 1)
- optional
Example Request
Method: GET
URL: http://domain/api/affiliate/campaigns
Query String: loginid=3&start=0&count=1000&orderby=name+ASC
Response:
{
"result": [
{
"campaignid": 0,
"name": "Default"
}
]
}
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(
'loginid' => '3',
'start' => 0,
'count' => 1000,
'orderby' => 'name ASC',
);
$request = Array(
'method' => 'GET',
'path' => 'v1/affiliate/campaigns',
'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);
?>
