NATS5 REST API Biller POST cascade-step
From TMM Wiki
Revision as of 15:17, 9 August 2019 by TMMJoe (talk | contribs) (TMMJoe moved page NATS4 REST API Biller POST cascade-step to NATS5 REST API Biller POST cascade-step: Renaming NATS5 API pages)
POST /biller/cascade-step
Description
- Add new cascade step
Resource URL
- http://domain/api/biller/cascade-step
- Replace domain with the nats domain
- POST
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- cascadeid
- type: digit
- required
- step_type
- type: string
- required
- billerid
- type: digit
- optional
- special
- type: string
- optional
- type
- type: string
- optional
- target
- type: string_list (Either a comma-separated string of strings, or a JSON array of strings)
- optional
- nontarget
- type: string_list (Either a comma-separated string of strings, or a JSON array of strings)
- optional
- prepend
- type: boolean_digit
- optional
Example Request
Method: POST
URL: http://domain/api/biller/cascade-step
Form Data:
- cascadeid: 1
- step_type: biller
- billerid: 2
Response:
{
"success": true,
"result": "Added cascade step 2",
"cascade_item_id": 2
}
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(
'cascadeid' => 1,
'step_type' => 'biller',
'billerid' => 2,
);
$request = Array(
'method' => 'POST',
'path' => 'v1/biller/cascade-step',
'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);
?>
