Difference between revisions of "NATS5 REST API Biller GET partner-list"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Biller GET partner-list to NATS5 REST API Biller GET partner-list: Renaming NATS5 API pages) |
|||
(One intermediate revision by the same user not shown) | |||
Line 1: | Line 1: | ||
− | {{ | + | {{NATS5 Manual |
− | | | + | | show_api_admin_biller_section = true |
}} | }} | ||
== '''GET /biller/partner-list''' == | == '''GET /biller/partner-list''' == | ||
+ | |||
'''Description''' | '''Description''' | ||
* Get list of partners | * Get list of partners | ||
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''']] |
*GET | *GET | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
− | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
Line 34: | Line 35: | ||
Method: '''GET'''<br/> | Method: '''GET'''<br/> | ||
URL: <nowiki>http://domain/api/biller/partner-list</nowiki><br/> | URL: <nowiki>http://domain/api/biller/partner-list</nowiki><br/> | ||
+ | Query String: <nowiki>deleted=1&partner=ADULTFRIENDFINDER</nowiki><br/> | ||
Response: | Response: | ||
Line 45: | Line 47: | ||
"networkid": "0", | "networkid": "0", | ||
"biller": "ADULTFRIENDFINDER", | "biller": "ADULTFRIENDFINDER", | ||
− | "last_poll": " | + | "last_poll": "1565382539", |
"form_method": "0", | "form_method": "0", | ||
"deleted": "0", | "deleted": "0", | ||
Line 133: | Line 135: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
− | $data = | + | $data = Array( |
− | + | 'deleted' => 1, | |
+ | 'partner' => 'ADULTFRIENDFINDER', | ||
); | ); | ||
Line 176: | Line 179: | ||
</pre> | </pre> | ||
− | [[Category: | + | [[Category:NATS5_REST_APIs]] |
− | [[Category: | + | [[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 --> | [[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 16:58, 9 August 2019
GET /biller/partner-list
Description
- Get list of partners
Resource URL
- http://domain/api/biller/partner-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
- partner
- type: string
- optional
- detail
- type: string
- optional
Example Request
Method: GET
URL: http://domain/api/biller/partner-list
Query String: deleted=1&partner=ADULTFRIENDFINDER
Response:
{ "success": true, "total_count": 1, "partners": [ { "billerid": "3", "networkid": "0", "biller": "ADULTFRIENDFINDER", "last_poll": "1565382539", "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 }, { "field": "third_acctinfo_password", "display_name": "Password", "value": "****", "type": "password", "values": false, "unique": 0, "required": 1 }, { "field": "third_acctinfo_defaultnats", "display_name": "Default Nats Code", "value": "", "type": "", "values": false, "unique": 0, "required": 0 }, { "field": "third_acctinfo_free_initials", "display_name": "Import Free Initials?", "value": "False", "type": "checkbox", "values": false, "unique": 0, "required": 0 }, { "field": "third_acctinfo_all_orders", "display_name": "Retrieve All Orders?", "value": "False", "type": "checkbox", "values": false, "unique": 0, "required": 0 }, { "field": "third_acctinfo_earnings", "display_name": "Report on Earnings\/Amount?", "value": "False", "type": "checkbox", "values": false, "unique": 0, "required": 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( 'deleted' => 1, 'partner' => 'ADULTFRIENDFINDER', ); $request = Array( 'method' => 'GET', 'path' => 'v1/biller/partner-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); ?>