Difference between revisions of "NATS5 REST API Affiliate GET groups"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Affiliate GET groups to NATS5 REST API Affiliate GET groups: Renaming NATS5 API pages) |
|||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
== '''GET /affiliate/groups''' == | == '''GET /affiliate/groups''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get affiliate groups | * Get affiliate groups | ||
| Line 9: | Line 10: | ||
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']] |
*GET | *GET | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 22: | Line 23: | ||
* '''deleted''' | * '''deleted''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''loginid''' | * '''loginid''' | ||
| Line 31: | Line 32: | ||
Method: '''GET'''<br/> | Method: '''GET'''<br/> | ||
URL: <nowiki>http://domain/api/affiliate/groups</nowiki><br/> | URL: <nowiki>http://domain/api/affiliate/groups</nowiki><br/> | ||
| + | Query String: <nowiki>loginid=3&deleted=1</nowiki><br/> | ||
Response: | Response: | ||
| Line 42: | Line 44: | ||
"description": "", | "description": "", | ||
"deleted": "0", | "deleted": "0", | ||
| − | "count": 0 | + | "count": 0, |
| + | "enabled": 0 | ||
} | } | ||
] | ] | ||
| Line 63: | Line 66: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| − | $data = | + | $data = Array( |
| − | + | 'loginid' => '3', | |
| + | 'deleted' => 1, | ||
); | ); | ||
| Line 106: | Line 110: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_affiliate_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 --> | ||
[[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | [[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | ||
Revision as of 15:43, 9 August 2019
GET /affiliate/groups
Description
- Get affiliate groups
Resource URL
- http://domain/api/affiliate/groups
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- deleted
- type: boolean_digit (0 or 1)
- optional
- loginid
- type: digit
- optional
Example Request
Method: GET
URL: http://domain/api/affiliate/groups
Query String: loginid=3&deleted=1
Response:
{
"success": true,
"groups": [
{
"groupid": "1",
"name": "testGroup",
"description": "",
"deleted": "0",
"count": 0,
"enabled": 0
}
]
}
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',
'deleted' => 1,
);
$request = Array(
'method' => 'GET',
'path' => 'v1/affiliate/groups',
'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);
?>
