NATS5 REST API Affiliate GET search-limited
From TMM Wiki
Jump to navigationJump to search
GET /affiliate/search-limited
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
- Search affiliates
Resource URL
- http://domain/api/affiliate/search-limited
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- count
- type: digit
- optional
- loginid_compare
- type: string
- optional (default value: =)
- loginid
- type: digit
- optional
- orderby
- optional
- start
- type: digit
- optional
- type
- type: digit
- optional
- username_compare
- type: string
- optional (default value: like)
- username
- type: string
- optional
Example Request
Method: GET
URL: http://domain/api/affiliate/search-limited
Query String: loginid=3&username=affiliateTest&start=0&count=100&type=0
Response:
{
"affiliates": [
{
"loginid": "3",
"username": "affiliateTest"
}
],
"total_count": "1",
"total": "1",
"params": {
"count": 100,
"loginid_compare": "=",
"loginid": "3",
"orderby": null,
"start": 0,
"type": 0,
"username_compare": "like",
"username": "affiliateTest"
}
}
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',
'username' => 'affiliateTest',
'start' => 0,
'count' => 100,
'type' => 0,
);
$request = Array(
'method' => 'GET',
'path' => 'v1/affiliate/search-limited',
'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);
?>
