GET /codes/decode
Note: This is an autogenerated wiki page for the NATS5 API. There may be additional descriptions or examples available on the NATS 4 API wiki for this API.
Description
- Decode a particular NATS code value
Resource URL
- http://domain/api/codes/decode
- Replace domain with the nats domain
Request Method
Response Format
Authentication
Parameters
Parameters can be sent as url encoded params
Example Request
Method: GET
URL: http://domain/api/codes/decode
Query String: natscode=MC4wLjEuMS4wLjAuMC4wLjA
Response:
{
"loginid": "0",
"programid": "0",
"siteid": "1",
"tourid": "1",
"campaignid": "0",
"adtoolid": "0",
"subid1": "0",
"subid2": "0",
"promotionalid": "0",
"is_unencoded": 0,
"old_code": 0,
"inhouse": 0,
"details": {
"siteid": {
"siteid": "1",
"site": "member_a",
"name": "Membership Site A",
"type": "0"
},
"tourid": {
"tourid": "1",
"tour": "MAIN",
"name": "Default Tour",
"url": "https:\/\/www.google.com",
"linkdomain": "root.nats4.com"
}
},
"campaign_name": null,
"success": true
}
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(
'natscode' => 'MC4wLjEuMS4wLjAuMC4wLjA',
);
$request = Array(
'method' => 'GET',
'path' => 'v1/codes/decode',
'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);
?>
