Difference between revisions of "NATS5 REST API Biller GET partner-detail"
From TMM Wiki
Jump to navigationJump to search| Line 25: | Line 25: | ||
** optional | ** optional | ||
| + | == '''Example Request''' == | ||
| + | Method: '''GET'''<br/> | ||
| + | URL: <nowiki>http://domain/api/biller/partner-detail</nowiki><br/> | ||
| + | Query String: <nowiki>billerid=3</nowiki><br/> | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "billerid": "3", | ||
| + | "networkid": "0", | ||
| + | "biller": "ADULTFRIENDFINDER", | ||
| + | "last_poll": "1559929893", | ||
| + | "form_method": "0", | ||
| + | "deleted": "0", | ||
| + | "type": "1", | ||
| + | "last_poll_run": "0", | ||
| + | "permanently_deleted": "0", | ||
| + | "last_ip_update": "0", | ||
| + | "last_sync_start": "0", | ||
| + | "last_sync_end": "0", | ||
| + | "last_sync_message": "", | ||
| + | "accountinfo": [ | ||
| + | { | ||
| + | "field": "third_acctinfo_username", | ||
| + | "display_name": "Affiliate ID", | ||
| + | "value": "", | ||
| + | "type": "", | ||
| + | "values": false, | ||
| + | "unique": 0, | ||
| + | "required": 1, | ||
| + | "noedit": 0 | ||
| + | }, | ||
| + | { | ||
| + | "field": "third_acctinfo_password", | ||
| + | "display_name": "Password", | ||
| + | "value": "", | ||
| + | "type": "password", | ||
| + | "values": false, | ||
| + | "unique": 0, | ||
| + | "required": 1, | ||
| + | "noedit": 0 | ||
| + | }, | ||
| + | { | ||
| + | "field": "third_acctinfo_defaultnats", | ||
| + | "display_name": "Default Nats Code", | ||
| + | "value": "", | ||
| + | "type": "", | ||
| + | "values": false, | ||
| + | "unique": 0, | ||
| + | "required": 0, | ||
| + | "noedit": 0 | ||
| + | }, | ||
| + | { | ||
| + | "field": "third_acctinfo_free_initials", | ||
| + | "display_name": "Import Free Initials?", | ||
| + | "value": "False", | ||
| + | "type": "checkbox", | ||
| + | "values": false, | ||
| + | "unique": 0, | ||
| + | "required": 0, | ||
| + | "noedit": 0 | ||
| + | }, | ||
| + | { | ||
| + | "field": "third_acctinfo_all_orders", | ||
| + | "display_name": "Retrieve All Orders?", | ||
| + | "value": "False", | ||
| + | "type": "checkbox", | ||
| + | "values": false, | ||
| + | "unique": 0, | ||
| + | "required": 0, | ||
| + | "noedit": 0 | ||
| + | }, | ||
| + | { | ||
| + | "field": "third_acctinfo_earnings", | ||
| + | "display_name": "Report on Earnings\/Amount?", | ||
| + | "value": "False", | ||
| + | "type": "checkbox", | ||
| + | "values": false, | ||
| + | "unique": 0, | ||
| + | "required": 0, | ||
| + | "noedit": 0 | ||
| + | } | ||
| + | ], | ||
| + | "nice_name": "Adult Friend Finder", | ||
| + | "nice_name_short": "Adult Friend Finder" | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
== '''Example Code''' == | == '''Example Code''' == | ||
| Line 38: | Line 128: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| − | $data = | + | $data = Array( |
| − | + | 'billerid' => 3, | |
); | ); | ||
| Line 84: | Line 174: | ||
[[Category:NATS4_REST_biller_Collection]] | [[Category:NATS4_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 --> | ||
Revision as of 13:26, 7 June 2019
GET /biller/partner-detail
Description
- Get details for a partner
Resource URL
- http://domain/api/biller/partner-detail
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- billerid
- type: digit
- optional
Example Request
Method: GET
URL: http://domain/api/biller/partner-detail
Query String: billerid=3
Response:
{
"billerid": "3",
"networkid": "0",
"biller": "ADULTFRIENDFINDER",
"last_poll": "1559929893",
"form_method": "0",
"deleted": "0",
"type": "1",
"last_poll_run": "0",
"permanently_deleted": "0",
"last_ip_update": "0",
"last_sync_start": "0",
"last_sync_end": "0",
"last_sync_message": "",
"accountinfo": [
{
"field": "third_acctinfo_username",
"display_name": "Affiliate ID",
"value": "",
"type": "",
"values": false,
"unique": 0,
"required": 1,
"noedit": 0
},
{
"field": "third_acctinfo_password",
"display_name": "Password",
"value": "",
"type": "password",
"values": false,
"unique": 0,
"required": 1,
"noedit": 0
},
{
"field": "third_acctinfo_defaultnats",
"display_name": "Default Nats Code",
"value": "",
"type": "",
"values": false,
"unique": 0,
"required": 0,
"noedit": 0
},
{
"field": "third_acctinfo_free_initials",
"display_name": "Import Free Initials?",
"value": "False",
"type": "checkbox",
"values": false,
"unique": 0,
"required": 0,
"noedit": 0
},
{
"field": "third_acctinfo_all_orders",
"display_name": "Retrieve All Orders?",
"value": "False",
"type": "checkbox",
"values": false,
"unique": 0,
"required": 0,
"noedit": 0
},
{
"field": "third_acctinfo_earnings",
"display_name": "Report on Earnings\/Amount?",
"value": "False",
"type": "checkbox",
"values": false,
"unique": 0,
"required": 0,
"noedit": 0
}
],
"nice_name": "Adult Friend Finder",
"nice_name_short": "Adult Friend Finder"
}
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(
'billerid' => 3,
);
$request = Array(
'method' => 'GET',
'path' => 'v1/biller/partner-detail',
'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);
?>
