Difference between revisions of "NATS4 REST API Get Member Upsell String"
From TMM Wiki
Jump to navigationJump to search| Line 2: | Line 2: | ||
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
| − | == '''GET /member/ | + | == '''GET /member/authstring''' == |
'''Description''' | '''Description''' | ||
*The member/upsellstring API resource is a feature in [[NATS4]] that allows you to perform upsells for [[Ct#Member|members]] using an API call. | *The member/upsellstring API resource is a feature in [[NATS4]] that allows you to perform upsells for [[Ct#Member|members]] using an API call. | ||
'''Resource URL''' | '''Resource URL''' | ||
| − | *<nowiki>http://domain/api/member/ | + | *<nowiki>http://domain/api/member/authstring</nowiki> |
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| Line 21: | Line 21: | ||
== '''Parameters''' == | == '''Parameters''' == | ||
| − | ''''' | + | '''''Parameters 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. | 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. | ||
| Line 34: | Line 34: | ||
*Note: This API function will only look up active members. Looking up an inactive or expired member will cause a blank return. | *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 transaction.'' | ||
| + | **'''''type: string''''' | ||
| + | **'''''required''' | ||
| + | **'''''options: | ||
| + | ***upsell | ||
| + | ***tokenrebuy | ||
| + | ***instantupgrade | ||
| + | ***packageupgrade | ||
| + | ***cancel | ||
| + | ***signupplus | ||
* memberid: ''The member ID for the member.'' | * memberid: ''The member ID for the member.'' | ||
**'''''type: integer''''' | **'''''type: integer''''' | ||
| Line 47: | Line 58: | ||
**'''''optional''' | **'''''optional''' | ||
* username: ''The username for the member.'' | * username: ''The username for the member.'' | ||
| + | **'''''type: string''''' | ||
| + | **'''''optional''' | ||
| + | * status: ''The status for the member.'' | ||
**'''''type: string''''' | **'''''type: string''''' | ||
**'''''optional''' | **'''''optional''' | ||
| Line 164: | Line 178: | ||
curl -X GET 'http://domain/api/member/upsellstring?username=testakovsky2&siteid=1' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu" | curl -X GET 'http://domain/api/member/upsellstring?username=testakovsky2&siteid=1' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu" | ||
</pre> | </pre> | ||
| + | |||
| + | == '''Legacy Changes''' == | ||
| + | '''''Use the following documentation changes if you are using the REST API with NATS versions below <font style="color: red;">4.1.13.5</font>:''''' | ||
| + | |||
| + | '''GET /member/upsellstring''' | ||
| + | '''Description''' | ||
| + | *The member/upsellstring API resource is a feature in [[NATS4]] that allows you to perform upsells for [[Ct#Member|members]] using an API call. | ||
| + | |||
| + | '''Resource URL''' | ||
| + | *<nowiki>http://domain/api/member/upsellstring</nowiki> | ||
| + | *Replace domain with the nats domain | ||
| + | |||
| + | '''[[NATS4_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']] | ||
| + | *GET | ||
| + | |||
| + | '''Response Format''' | ||
| + | *JSON | ||
| + | |||
| + | '''[[NATS4_REST_API_Overview#Authentication|Authentication]]''' | ||
| + | *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 | ||
[[Category:NATS4 API Articles]] | [[Category:NATS4 API Articles]] | ||
Revision as of 17:40, 26 September 2017
GET /member/authstring
Description
- The member/upsellstring API resource is a feature in NATS4 that allows you to perform upsells for members using an API call.
Resource URL
- http://domain/api/member/authstring
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters 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 transaction.
- type: string
- required
- options:
- upsell
- tokenrebuy
- instantupgrade
- packageupgrade
- cancel
- signupplus
- 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
- status: The status 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/upsellstring
- Response:
{
"upsell_string": "c43bf56a0fce19a9fc1a435f1f78c80d"
}
Example Code
PHP
<?php
$curl = curl_init();
$data = array(
'username' => 'testakovsky2',
'siteid' => 1
);
$data_string = http_build_query($data);
$url = 'http://domain/api/member/upsellstring?'.$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/upsellstring'
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/upsellstring',
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/upsellstring?username=testakovsky2&siteid=1' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu"
Legacy Changes
Use the following documentation changes if you are using the REST API with NATS versions below 4.1.13.5:
GET /member/upsellstring Description
- The member/upsellstring API resource is a feature in NATS4 that allows you to perform upsells for members using an API call.
Resource URL
- http://domain/api/member/upsellstring
- 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
