Difference between revisions of "NATS5 REST API Biller GET cascades-available"
From TMM Wiki
Jump to navigationJump to search| Line 43: | Line 43: | ||
| − | + | \* NATS will prefer country derived from ip. But, you can force a default by specifying country/countryid when requesting via ip | |
== '''Example Request''' == | == '''Example Request''' == | ||
Revision as of 14:44, 27 April 2023
GET /biller/cascades-available
Description
- Get cascades
Resource URL
- http://domain/api/biller/cascades-available
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- ip
- optional
- country
- optional
- countryid
- type: digit
- optional
- loginid
- type: digit
- required
- programid
- type: digit
- required
- siteid
- type: digit
- required
- tourid
- type: digit
- required
\* NATS will prefer country derived from ip. But, you can force a default by specifying country/countryid when requesting via ip
Example Request
Method: GET
URL: http://domain/api/biller/cascades-available
Query String: loginid=0&programid=0&siteid=0&tourid=0&country=USA
Response:
{
"success": true,
"cascades": [
{
"cascadeid": 1,
"name": "Join by Credit Card"
}
]
}
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' => 0,
'programid' => 0,
'siteid' => 0,
'tourid' => 0,
'country' => 'USA',
);
$request = Array(
'method' => 'GET',
'path' => 'v1/biller/cascades-available',
'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);
?>
