NATS5 REST API Biller GET list
From TMM Wiki
Revision as of 15:17, 9 August 2019 by TMMJoe (talk | contribs) (TMMJoe moved page NATS4 REST API Biller GET list to NATS5 REST API Biller GET list: Renaming NATS5 API pages)
GET /biller/list
Description
- Get list of billers
Resource URL
- http://domain/api/biller/list
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- deleted
- type: trinary_digit (0, 1, or 2)
- optional
- cascadeid
- type: digit
- optional
- biller
- type: string_list (Either a comma-separated string of strings, or a JSON array of strings)
- optional
- detail
- type: string
- optional
Example Request
Method: GET
URL: http://domain/api/biller/list
Response:
{
"success": true,
"total_count": 2,
"billers": [
{
"billerid": "2",
"networkid": "0",
"biller": "CCBILL",
"last_poll": "",
"form_method": "0",
"deleted": "0",
"type": "0",
"last_poll_run": "0",
"permanently_deleted": "0",
"last_ip_update": "1559929893",
"last_sync_start": "0",
"last_sync_end": "0",
"last_sync_message": "",
"accountinfo": [
{
"field": "biller_acctinfo_clientAccnum",
"display_name": "Account Number",
"value": "",
"type": "text",
"values": false,
"unique": 1,
"required": 1
},
{
"field": "biller_acctinfo_dlusername",
"display_name": "Datalink Username",
"value": "",
"type": "",
"values": false,
"unique": 0,
"required": 1
},
{
"field": "biller_acctinfo_dlpassword",
"display_name": "Datalink Password",
"value": "****",
"type": "password",
"values": false,
"unique": 0,
"required": 1
},
{
"field": "biller_acctinfo_adv_dynamic_upgrade",
"display_name": "Advanced Dynamic Upgrades",
"value": "False",
"type": "checkbox",
"values": false,
"unique": 0,
"required": 0
}
],
"nice_name": "CCBill",
"nice_name_short": "CCBill"
},
{
"billerid": "1",
"networkid": "0",
"biller": "NETBILLING",
"last_poll": "",
"form_method": "0",
"deleted": "0",
"type": "0",
"last_poll_run": "0",
"permanently_deleted": "0",
"last_ip_update": "1533153249",
"last_sync_start": "0",
"last_sync_end": "0",
"last_sync_message": "",
"accountinfo": [
{
"field": "biller_acctinfo_account_id",
"display_name": "Account",
"value": "1234",
"type": "text",
"values": false,
"unique": 1,
"required": 1
},
{
"field": "biller_acctinfo_dynip_sec_code",
"display_name": "Dynamic IP Code",
"value": "",
"type": "",
"values": false,
"unique": 0,
"required": 0
}
],
"nice_name": "NETbilling",
"nice_name_short": "NETbilling"
}
]
}
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(
// Add API parameters here
);
$request = Array(
'method' => 'GET',
'path' => 'v1/biller/list',
'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);
?>
