Difference between revisions of "NATS4 REST API Get Member Cancel String"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS4 Manual | show_api_admin_section = true }} == '''GET /member/cancelstring''' == '''Description''' *The member/cancelstring API resource is a feature in NATS4 that...") |
|||
| (4 intermediate revisions by one other user not shown) | |||
| Line 2: | Line 2: | ||
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
| + | |||
| + | =For NATS 4.1.14.1+= | ||
| + | <span style="color:red;font-size:200%">If you are on any version of NATS 4.1.14.1 and up, Please refer to the new API call: [[NATS4 REST API Get Member Auth String|GET /member/authstring]]</span> | ||
| + | |||
| + | =Legacy Changes= | ||
| + | |||
== '''GET /member/cancelstring''' == | == '''GET /member/cancelstring''' == | ||
'''Description''' | '''Description''' | ||
| − | *The member/cancelstring API resource is a feature in [[NATS4]] that allows you to get the cancel string for[[Ct#Member|members']] using an API call. | + | *The member/cancelstring API resource is a feature in [[NATS4]] that allows you to get the cancel string for [[Ct#Member|members']] using an API call. |
'''Resource URL''' | '''Resource URL''' | ||
| − | *<nowiki>http://domain/api | + | *<nowiki>http://domain/api/member/cancelstring</nowiki> |
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| Line 61: | Line 67: | ||
'''GET''' | '''GET''' | ||
| − | <nowiki>http://domain/api | + | <nowiki>http://domain/api/member/cancelstring</nowiki> |
*Response: | *Response: | ||
<pre> | <pre> | ||
{ | { | ||
| − | " | + | "cancel_string": "41a281e2c536facf563c73b5840f58eb" |
} | } | ||
</pre> | </pre> | ||
| Line 83: | Line 89: | ||
$data_string = http_build_query($data); | $data_string = http_build_query($data); | ||
| − | $url = 'http://domain/api | + | $url = 'http://domain/api/member/cancelstring?'.$data_string; |
$headers = array( | $headers = array( | ||
| − | ' | + | 'api-key: 44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username: tmm1phrvezsbu' |
); | ); | ||
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); | curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); | ||
| Line 107: | Line 113: | ||
import requests | import requests | ||
| − | url = 'http://domain/api | + | url = 'http://domain/api/member/cancelstring' |
params = { | params = { | ||
| Line 115: | Line 121: | ||
headers = { | headers = { | ||
| − | ' | + | 'api-key': '44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username': 'tmm1phrvezsbu' |
} | } | ||
| Line 132: | Line 138: | ||
var options = { | var options = { | ||
| − | url: 'http://domain/api | + | url: 'http://domain/api/member/cancelstring', |
method: 'GET', | method: 'GET', | ||
qs: { | qs: { | ||
| Line 140: | Line 146: | ||
json: true, | json: true, | ||
headers: { | headers: { | ||
| − | ' | + | 'api-key': '44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username': 'tmm1phrvezsbu' |
} | } | ||
}; | }; | ||
| Line 162: | Line 168: | ||
'''Curl''' | '''Curl''' | ||
<pre> | <pre> | ||
| − | curl -X GET 'http://domain/api | + | curl -X GET 'http://domain/api/member/cancelstring?username=testakovsky2&siteid=1' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu" |
</pre> | </pre> | ||
[[Category:NATS4 API Articles]] | [[Category:NATS4 API Articles]] | ||
Latest revision as of 12:09, 30 April 2018
For NATS 4.1.14.1+
If you are on any version of NATS 4.1.14.1 and up, Please refer to the new API call: GET /member/authstring
Legacy Changes
GET /member/cancelstring
Description
- The member/cancelstring API resource is a feature in NATS4 that allows you to get the cancel string for members' using an API call.
Resource URL
- http://domain/api/member/cancelstring
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
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.
- memberid: The member ID for the member.
- type: integer
- optional
- session: The session ID for the member.
- type: string
- optional
- siteid: The site id you want.
- type: integer
- optional
- siteids: Comma separated site ids. ex: ('1,2,3,4')
- type: string
- optional
- username: The username for the member.
- type: string
- optional
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
Example Request
GET
http://domain/api/member/cancelstring
- Response:
{
"cancel_string": "41a281e2c536facf563c73b5840f58eb"
}
Example Code
PHP
<?php
$curl = curl_init();
$data = array(
'username' => 'testakovsky2',
'siteid' => 1
);
$data_string = http_build_query($data);
$url = 'http://domain/api/member/cancelstring?'.$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/cancelstring'
params = {
'username': 'testakovsky2',
'siteid': '1'
}
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/cancelstring',
method: 'GET',
qs: {
'username': 'testakovsky2',
'siteid': '1'
},
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/cancelstring?username=testakovsky2&siteid=1' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu"
