Difference between revisions of "NATS4 REST API Decode Natscode"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS4 Manual | show_api_admin_section = true }} == '''GET /decodenatscode''' == '''Description''' *NATS4 supports an API resource to decode a natscode sent to the decod...") |
|||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 2: | Line 2: | ||
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
| − | == '''GET /decodenatscode''' == | + | == '''GET /service/decodenatscode''' == |
'''Description''' | '''Description''' | ||
*[[NATS4]] supports an API resource to decode a natscode sent to the decodenatscode endpoint | *[[NATS4]] supports an API resource to decode a natscode sent to the decodenatscode endpoint | ||
'''Resource URL''' | '''Resource URL''' | ||
| − | *<nowiki>http://domain/api/ | + | *<nowiki>http://domain/api/codes/decode</nowiki> |
| − | *Replace domain with | + | *Replace domain with your nats domain |
| − | '''[[NATS4_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''' | + | '''[[NATS4_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method]]''' |
*GET | *GET | ||
| Line 23: | Line 23: | ||
'''''Paremeters can be sent as url encoded params.''' | '''''Paremeters can be sent as url encoded params.''' | ||
| − | *''' | + | *'''natscode''': ''The natscode you would like to decode.'' |
**'''''type: string''''' | **'''''type: string''''' | ||
| − | **''''' | + | **'''''required''''' |
| Line 32: | Line 32: | ||
'''GET''' | '''GET''' | ||
| − | <nowiki>http://domain/api/ | + | <nowiki>http://domain/api/service/decodenatscode</nowiki> |
*Response: | *Response: | ||
| Line 61: | Line 61: | ||
$data = array( | $data = array( | ||
| − | ' | + | 'natscode' => 'MS4yLjIuMi4wLjAuMC4wLjA' |
); | ); | ||
$data_string = http_build_query($data); | $data_string = http_build_query($data); | ||
| − | $url = 'http://domain/api/ | + | $url = 'http://domain/api/service/decodenatscode?'.$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 77: | Line 77: | ||
$resp = curl_exec($curl); | $resp = curl_exec($curl); | ||
//dumps an associative array representation of the json | //dumps an associative array representation of the json | ||
| − | + | $output = json_decode($resp,TRUE); | |
| + | if ($output === NULL) { | ||
| + | print_r($resp); | ||
| + | } | ||
| + | else { | ||
| + | var_dump($output); | ||
| + | } | ||
// Close request to clear up some resources | // Close request to clear up some resources | ||
curl_close($curl); | curl_close($curl); | ||
?> | ?> | ||
| − | |||
</pre> | </pre> | ||
| Line 89: | Line 94: | ||
import requests | import requests | ||
| − | url = 'http://domain/api/ | + | url = 'http://domain/api/service/decodenatscode' |
params = { | params = { | ||
| − | ' | + | 'natscode': 'MS4yLjIuMi4wLjAuMC4wLjA' |
} | } | ||
headers = { | headers = { | ||
| − | ' | + | 'api-key': '44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username': 'tmm1phrvezsbu' |
} | } | ||
| − | |||
res = requests.get(url, params=params, headers=headers) | res = requests.get(url, params=params, headers=headers) | ||
print res.json() | print res.json() | ||
| − | |||
</pre> | </pre> | ||
| Line 113: | Line 116: | ||
var options = { | var options = { | ||
| − | url: 'http://domain/api/ | + | url: 'http://domain/api/service/decodenatscode', |
method: 'GET', | method: 'GET', | ||
qs: { | qs: { | ||
| − | ' | + | 'natscode': 'MS4yLjIuMi4wLjAuMC4wLjA' |
}, | }, | ||
json: true, | json: true, | ||
headers: { | headers: { | ||
| − | ' | + | 'api-key': '44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username': 'tmm1phrvezsbu' |
} | } | ||
}; | }; | ||
| Line 137: | Line 140: | ||
request(options, callback); | request(options, callback); | ||
| − | |||
</pre> | </pre> | ||
'''Curl''' | '''Curl''' | ||
<pre> | <pre> | ||
| − | curl -X GET 'http://domain/api/ | + | curl -X GET 'http://domain/api/service/decodenatscode?natscode=MS4yLjIuMi4wLjAuMC4wLjA' -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>:''''' | ||
| + | |||
| + | '''Resource URL''' | ||
| + | *<nowiki>http://domain/api/decodenatscode</nowiki> | ||
| + | *Replace domain with your nats domain | ||
| + | |||
| + | '''Parameters''' - Paremeters can be sent as url encoded params. | ||
| + | |||
| + | *'''data''': ''The natscode you would like to decode.'' | ||
| + | **'''''type: string''''' | ||
| + | **'''''optional''''' | ||
[[Category:NATS4 API Articles]] | [[Category:NATS4 API Articles]] | ||
Latest revision as of 10:28, 19 August 2019
GET /service/decodenatscode
Description
- NATS4 supports an API resource to decode a natscode sent to the decodenatscode endpoint
Resource URL
- http://domain/api/codes/decode
- Replace domain with your nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Paremeters can be sent as url encoded params.
- natscode: The natscode you would like to decode.
- type: string
- required
Example Request
GET
http://domain/api/service/decodenatscode
- Response:
{
"loginid": "1",
"programid": "2",
"siteid": "2",
"tourid": "2",
"campaignid": "0",
"adtoolid": "0",
"subid1": "0",
"subid2": "0",
"promotionalid": "0",
"is_unencoded": 0,
"old_code": 0,
"inhouse": "0",
"username": "tmm1phrvezsbu"
}
Example Code
PHP
<?php
$curl = curl_init();
$data = array(
'natscode' => 'MS4yLjIuMi4wLjAuMC4wLjA'
);
$data_string = http_build_query($data);
$url = 'http://domain/api/service/decodenatscode?'.$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
$output = json_decode($resp,TRUE);
if ($output === NULL) {
print_r($resp);
}
else {
var_dump($output);
}
// 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/service/decodenatscode'
params = {
'natscode': 'MS4yLjIuMi4wLjAuMC4wLjA'
}
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/service/decodenatscode',
method: 'GET',
qs: {
'natscode': 'MS4yLjIuMi4wLjAuMC4wLjA'
},
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/service/decodenatscode?natscode=MS4yLjIuMi4wLjAuMC4wLjA' -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:
Resource URL
- http://domain/api/decodenatscode
- Replace domain with your nats domain
Parameters - Paremeters can be sent as url encoded params.
- data: The natscode you would like to decode.
- type: string
- optional
