Difference between revisions of "NATS5 REST API Biller POST cascade-step"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS4 Manual | show_api_admin_section = true }} == '''POST /biller/cascade-step''' == '''Description''' * Add new cascade step '''Resource URL''' *<nowiki>http://domain/ap...") |
|||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_biller_section = true |
}} | }} | ||
== '''POST /biller/cascade-step''' == | == '''POST /biller/cascade-step''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Add new cascade step | * Add new cascade step | ||
| 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''']] |
*POST | *POST | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 43: | Line 44: | ||
** optional | ** optional | ||
* '''prepend''' | * '''prepend''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
| − | [[Category: | + | == '''Example Request''' == |
| − | [[Category: | + | Method: '''POST'''<br/> |
| + | URL: <nowiki>http://domain/api/biller/cascade-step</nowiki><br/> | ||
| + | Form Data:<br/> | ||
| + | * cascadeid: 1 | ||
| + | * step_type: biller | ||
| + | * billerid: 2 | ||
| + | * type: cc | ||
| + | * target: USA | ||
| + | * nontarget: AX | ||
| + | * prepend: 0 | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "success": true, | ||
| + | "result": "Added cascade step 2", | ||
| + | "cascade_item_id": 2 | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | == '''Example Code''' == | ||
| + | |||
| + | '''PHP''' | ||
| + | <pre> | ||
| + | <?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, | ||
| + | 'type' => 'cc', | ||
| + | 'target' => 'USA', | ||
| + | 'nontarget' => 'AX', | ||
| + | 'prepend' => 0, | ||
| + | ); | ||
| + | |||
| + | $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); | ||
| + | ?> | ||
| + | </pre> | ||
| + | |||
| + | [[Category:NATS5_REST_APIs]] | ||
| + | [[Category:NATS5_REST_biller_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 --> | ||
Latest revision as of 15:58, 9 August 2019
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 (0 or 1)
- optional
Example Request
Method: POST
URL: http://domain/api/biller/cascade-step
Form Data:
- cascadeid: 1
- step_type: biller
- billerid: 2
- type: cc
- target: USA
- nontarget: AX
- prepend: 0
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,
'type' => 'cc',
'target' => 'USA',
'nontarget' => 'AX',
'prepend' => 0,
);
$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);
?>
