Difference between revisions of "NATS5 REST API Codes GET affiliate-codes"
From TMM Wiki
Jump to navigationJump to search| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_codes_section = true |
}} | }} | ||
== '''GET /codes/affiliate-codes''' == | == '''GET /codes/affiliate-codes''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get a list of NATS code values and links for a specific affiliate and program | * Get a list of NATS code values and links for a specific affiliate and program | ||
| Line 9: | Line 10: | ||
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']] |
*GET | *GET | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 55: | Line 56: | ||
Method: '''GET'''<br/> | Method: '''GET'''<br/> | ||
URL: <nowiki>http://domain/api/codes/affiliate-codes</nowiki><br/> | URL: <nowiki>http://domain/api/codes/affiliate-codes</nowiki><br/> | ||
| − | Query String: <nowiki>loginid=1&programid=1&siteid=1</nowiki><br/> | + | Query String: <nowiki>loginid=1&programid=1&siteid=1&tourid=1&campaignid=1&adtoolid=1&subid1=2&promotionalid=1&link_style=encoded</nowiki><br/> |
Response: | Response: | ||
| Line 66: | Line 67: | ||
"tourid": 1, | "tourid": 1, | ||
"tour_name": "Default Tour", | "tour_name": "Default Tour", | ||
| − | "track_url": "http:\/\/root.nats4.com\/track\/ | + | "track_url": "http:\/\/root.nats4.com\/track\/MS4xLjEuMS4xLjEuMi4wLjA", |
| − | "nats_code": " | + | "nats_code": "MS4xLjEuMS4xLjEuMi4wLjA" |
} | } | ||
], | ], | ||
| Line 93: | Line 94: | ||
'programid' => 1, | 'programid' => 1, | ||
'siteid' => 1, | 'siteid' => 1, | ||
| + | 'tourid' => 1, | ||
| + | 'campaignid' => 1, | ||
| + | 'adtoolid' => 1, | ||
| + | 'subid1' => 2, | ||
| + | 'promotionalid' => 1, | ||
| + | 'link_style' => 'encoded', | ||
); | ); | ||
| Line 134: | Line 141: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_codes_Collection]] |
[[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | [[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | ||
[[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | [[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | ||
Latest revision as of 15:59, 9 August 2019
GET /codes/affiliate-codes
Description
- Get a list of NATS code values and links for a specific affiliate and program
Resource URL
- http://domain/api/codes/affiliate-codes
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- loginid
- type: digit
- required
- programid
- type: digit
- required
- siteid
- type: digit
- optional
- tourid
- type: digit
- optional
- campaignid
- type: digit
- optional
- adtoolid
- type: digit
- optional
- subid1
- type: digit
- optional
- subid2
- type: digit
- optional
- promotionalid
- type: digit
- optional
- link_style
- type: string
- optional (default value: encoded)
Example Request
Method: GET
URL: http://domain/api/codes/affiliate-codes
Query String: loginid=1&programid=1&siteid=1&tourid=1&campaignid=1&adtoolid=1&subid1=2&promotionalid=1&link_style=encoded
Response:
{
"return": [
{
"siteid": 1,
"site_name": "Membership Site A",
"tourid": 1,
"tour_name": "Default Tour",
"track_url": "http:\/\/root.nats4.com\/track\/MS4xLjEuMS4xLjEuMi4wLjA",
"nats_code": "MS4xLjEuMS4xLjEuMi4wLjA"
}
],
"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(
'loginid' => 1,
'programid' => 1,
'siteid' => 1,
'tourid' => 1,
'campaignid' => 1,
'adtoolid' => 1,
'subid1' => 2,
'promotionalid' => 1,
'link_style' => 'encoded',
);
$request = Array(
'method' => 'GET',
'path' => 'v1/codes/affiliate-codes',
'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);
?>
