/api/codes/linkcodes

get

Get link codes for particular for the given parameters

Authorizations

api-keystringRequired

api-usernamestringRequired

Query parameters

loginidintegerOptionalDefault: 0

programidintegerOptionalDefault: 0

siteidintegerOptionalDefault: 0

touridintegerOptionalDefault: 0

campaignidintegerOptionalDefault: 0

adtoolidintegerOptionalDefault: 0

subid1integerOptionalDefault: 0

subid2integerOptionalDefault: 0

Responses

200

success

successbooleanOptionalExample: true

get/api/codes/linkcodes

PHP (cURL)

<?php

$headers = array( //set your username and API key here
	'api-key: 44b5498dbcb481a0d00b404c0169af62',
	'api-username: tmm1phrvezsbu'
);
$url = 'https://yourdomain.com'; //set your NATS URL here

$data = array(
		'loginid' => 1,
		'programid' => 1,
		'siteid' => 1,
		'tourid' => 1,
		'campaignid' => 1,
		'adtoolid' => 1,
		'subid1' => 2
	);

$request = array(
	'method' => 'GET',
	'path' => 'codes/linkcodes',
	'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);
?>

200

success

{
  "success": true,
  "codes": {
    "natscode": {
      "encoded": "MS4xLjEuMS4xLjEuMi4wLjA",
      "unencoded": "productsupport.1.1.1.1.1.2.0.0",
      "shortname": "productsupport.50rev.member_a.MAIN.1.1.2.0.0"
    },
    "link": {
      "encoded": "http://root.nats4.com/track/MS4xLjEuMS4xLjEuMi4wLjA",
      "unencoded": "http://root.nats4.com/track/productsupport.1.1.1.1.1.2.0.0",
      "shortname": "http://root.nats4.com/track/productsupport.50rev.member_a.MAIN.1.1.2.0.0",
      "qualified": "http://root.nats4.com/ttrack/MS4xLjEuMS4xLjEuMi4wLjA/",
      "join_full": "http://root.nats4.com/signup/signup.php?nats=MS4xLjEuMS4xLjEuMi4wLjA&step=2",
      "popup": "<script language='JavaScript' src='http://root.nats4.com/include/MS4xLjEuMS4xLjEuMi4wLjA'></script>",
      "php_encoded": "http://root.nats4.com/track/<?=!empty($_GET['nats'])?$_GET['nats']:'MS4xLjEuMS4xLjEuMi4wLjA'?>/",
      "php_qualified": "http://root.nats4.com/ttrack/<?=!empty($_GET['nats'])?$_GET['nats']:'MS4xLjEuMS4xLjEuMi4wLjA'?>/",
      "smarty_tour": "http://root.nats4.com/track/{if !empty($smarty.get.nats)}{$smarty.get.nats}{else}MS4xLjEuMS4xLjEuMi4wLjA{/if}/",
      "php_join": "http://root.nats4.com/track/<?=!empty($_GET['nats'])?$_GET['nats']:'MS4xLjEuMS4xLjEuMi4wLjA'?>/join",
      "php_join_full": "http://root.nats4.com/signup/signup.php?nats=<?=!empty($_GET['nats'])?$_GET['nats']:'MS4xLjEuMS4xLjEuMi4wLjA'?>&step=2",
      "smarty_join": "http://root.nats4.com/track/{if !empty($smarty.get.nats)}{$smarty.get.nats}{else}MS4xLjEuMS4xLjEuMi4wLjA{/if}/join",
      "php_popup": "<script language='JavaScript' src='http://root.nats4.com/include/<?=!empty($_GET['nats'])?$_GET['nats']:'MS4xLjEuMS4xLjEuMi4wLjA'?>'></script>"
    }
  }
}