Difference between revisions of "NATS5 REST API Codes GET strack"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Codes GET strack to NATS5 REST API Codes GET strack: Renaming NATS5 API pages) |
|||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
== '''GET /codes/strack''' == | == '''GET /codes/strack''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get strack links | * Get strack links | ||
| 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 31: | Line 32: | ||
** optional | ** optional | ||
* '''track''' | * '''track''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
| Line 37: | Line 38: | ||
Method: '''GET'''<br/> | Method: '''GET'''<br/> | ||
URL: <nowiki>http://domain/api/codes/strack</nowiki><br/> | URL: <nowiki>http://domain/api/codes/strack</nowiki><br/> | ||
| + | Query String: <nowiki>programid=1&siteid=1&tourid=1&track=0</nowiki><br/> | ||
Response: | Response: | ||
| Line 43: | Line 45: | ||
"success": true, | "success": true, | ||
"links": { | "links": { | ||
| − | "php_link": "http:\/\/ | + | "php_link": "http:\/\/root.nats4.com\/strack\/<?=!empty($_GET['nats'])?$_GET['nats']:'MC4wLjEuMS4wLjAuMC4wLjA'?>\/1:1\/1\/0\/", |
| − | "smarty_link": "http:\/\/ | + | "smarty_link": "http:\/\/root.nats4.com\/strack\/{if !empty($smarty.get.nats)}{$smarty.get.nats}{else}MC4wLjEuMS4wLjAuMC4wLjA{\/if}\/1:1\/1\/0\/" |
} | } | ||
} | } | ||
| Line 64: | Line 66: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| − | $data = | + | $data = Array( |
| − | + | 'programid' => 1, | |
| + | 'siteid' => 1, | ||
| + | 'tourid' => 1, | ||
| + | 'track' => 0, | ||
); | ); | ||
| Line 107: | Line 112: | ||
</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 --> | ||
Revision as of 15:44, 9 August 2019
GET /codes/strack
Description
- Get strack links
Resource URL
- http://domain/api/codes/strack
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- programid
- type: digit
- optional
- siteid
- type: digit
- optional
- tourid
- type: digit
- optional
- track
- type: boolean_digit (0 or 1)
- optional
Example Request
Method: GET
URL: http://domain/api/codes/strack
Query String: programid=1&siteid=1&tourid=1&track=0
Response:
{
"success": true,
"links": {
"php_link": "http:\/\/root.nats4.com\/strack\/<?=!empty($_GET['nats'])?$_GET['nats']:'MC4wLjEuMS4wLjAuMC4wLjA'?>\/1:1\/1\/0\/",
"smarty_link": "http:\/\/root.nats4.com\/strack\/{if !empty($smarty.get.nats)}{$smarty.get.nats}{else}MC4wLjEuMS4wLjAuMC4wLjA{\/if}\/1:1\/1\/0\/"
}
}
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(
'programid' => 1,
'siteid' => 1,
'tourid' => 1,
'track' => 0,
);
$request = Array(
'method' => 'GET',
'path' => 'v1/codes/strack',
'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);
?>
