For NATS 4.1.14.1+
GET /member/authstring
Description
- The member/authstring API resource is a feature in NATS4 that allows you to retrieve the authstring for several NATS features:
- UpsellPlus
- TokenPlus
- UpgradePlus
- PackagePlus
- CancelPlus
- SignupPlus
Resource URL
- http://domain/api/member/authstring
- Replace domain with the nats domain
Request Method
Response Format
Authentication
Parameters
Paremeters can be sent as url encoded params.
These are parameters used to specify which member you're looking for. This function will only return one member; use these filters to choose which one.
In order to get a return from this function, you must use a combination of these filters when requesting information. The possible combinations here are:
- memberid and session
- username and siteid
- username and siteids
- Note: This API function will only look up active members. Looking up an inactive or expired member will cause a blank return.
- type: The type of plus system for the member.
- type: integer
- required
- Most common possible values:
- upsell
- tokenrebuy
- instantupgrade
- packageupgrade
- cancel
- signupplus
- memberid: The member ID for the member.
- session: The session ID for the member.
- siteid: The site id you want.
- siteids: Comma separated site ids. ex: ('1,2,3,4')
- username: The username for the member.
- status: The status for the member.
- type: integer
- optional
- Most common possible values:
- 0 => never joined
- 1 => active
- 2 => expired
Example Request
GET
http://domain/api/member/authstring
{
"result":"877ae8d2c00e617d443643326bb848e2"
}
Example Code
PHP
<?php
$curl = curl_init();
$data = array(
'type' => 'instantupgrade'
'memberid' => '342'
'session' => 'd2877c3303d01165f780f63bd9da3620'
);
$data_string = http_build_query($data);
$url = 'http://domain/api/member/authstring?'.$data_string;
$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);
$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);
?>
Python
- This example requires pip and the request library which can be installed via pip by: 'pip install requests'
import requests
url = 'http://domain/api/member/authstring'
params = {
'type' => 'instantupgrade'
'memberid' => '342'
'session' => 'd2877c3303d01165f780f63bd9da3620'
}
headers = {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'tmm1phrvezsbu'
}
res = requests.get(url, params=params, headers=headers)
print res.json()
node.js
- This example requires npm and the request module which can be installed via npm by: 'npm install request'
var request = require('request');
var options = {
url: 'http://domain/api/member/authstring',
method: 'GET',
qs: {
'type' => 'instantupgrade'
'memberid' => '342'
'session' => 'd2877c3303d01165f780f63bd9da3620'
},
json: true,
headers: {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'tmm1phrvezsbu'
}
};
function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
else{
console.log(body);
}
}
request(options, callback);
Curl
curl -X GET 'http://domain/api/member/authstring?type=instantupgrade&memberid=342&session=d2877c3303d01165f780f63bd9da3620' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu"
Legacy
Use the following documentation changes if you are using the REST API with NATS versions below 4.1.13.5:
