Difference between revisions of "NATS5 REST API Biller GET partner-available"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS4 Manual | show_api_admin_section = true }} == '''GET /biller/partner-available''' == '''Description''' * Get available partners '''Resource URL''' *<nowiki>http://dom...") |
|||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_biller_section = true |
}} | }} | ||
== '''GET /biller/partner-available''' == | == '''GET /biller/partner-available''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get available partners | * Get available 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 20: | Line 21: | ||
None | None | ||
| − | [[Category: | + | == '''Example Request''' == |
| − | [[Category: | + | Method: '''GET'''<br/> |
| + | URL: <nowiki>http://domain/api/biller/partner-available</nowiki><br/> | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | [ | ||
| + | { | ||
| + | "nice": "Adult Friend Finder", | ||
| + | "short": "ADULTFRIENDFINDER" | ||
| + | }, | ||
| + | { | ||
| + | "nice": "Adult Friend Finder API", | ||
| + | "short": "ADULTFRIENDFINDERAPI" | ||
| + | }, | ||
| + | { | ||
| + | "nice": "Cams.com", | ||
| + | "short": "CAMS" | ||
| + | }, | ||
| + | { | ||
| + | "nice": "CamSpot", | ||
| + | "short": "CAMSPOT" | ||
| + | }, | ||
| + | { | ||
| + | "nice": "Datingfactory", | ||
| + | "short": "DATINGFACTORY" | ||
| + | }, | ||
| + | { | ||
| + | "nice": "DatingGold", | ||
| + | "short": "DATINGGOLD" | ||
| + | }, | ||
| + | { | ||
| + | "nice": "Effex Media", | ||
| + | "short": "EFFEX" | ||
| + | }, | ||
| + | { | ||
| + | "nice": "Fling.com", | ||
| + | "short": "FLING" | ||
| + | }, | ||
| + | { | ||
| + | "nice": "Flirt4Free", | ||
| + | "short": "FLIRT4FREE" | ||
| + | }, | ||
| + | { | ||
| + | "nice": "GameLink", | ||
| + | "short": "GAMELINK" | ||
| + | }, | ||
| + | { | ||
| + | "nice": "MallCom", | ||
| + | "short": "MALLCOM" | ||
| + | }, | ||
| + | { | ||
| + | "nice": "My Dirty Hobby", | ||
| + | "short": "MYDIRTYHOBBY" | ||
| + | }, | ||
| + | { | ||
| + | "nice": "Sexkey \/ Mansites", | ||
| + | "short": "SEXKEYMANSITES" | ||
| + | }, | ||
| + | { | ||
| + | "nice": "SexMoney SponsorCash", | ||
| + | "deprecated": "1", | ||
| + | "short": "SEXMONEY" | ||
| + | }, | ||
| + | { | ||
| + | "nice": "SexGoesMobile", | ||
| + | "short": "SGM" | ||
| + | }, | ||
| + | { | ||
| + | "nice": "StreaMate", | ||
| + | "short": "STREAMATE" | ||
| + | }, | ||
| + | { | ||
| + | "nice": "WebCamClub", | ||
| + | "short": "WEBCAMCLUB" | ||
| + | }, | ||
| + | { | ||
| + | "nice": "WebCams", | ||
| + | "short": "WEBCAMS" | ||
| + | }, | ||
| + | { | ||
| + | "nice": "WebCamWiz", | ||
| + | "short": "WEBCAMWIZ" | ||
| + | }, | ||
| + | { | ||
| + | "nice": "Wister", | ||
| + | "short": "WISTER" | ||
| + | }, | ||
| + | { | ||
| + | "nice": "XloveCash", | ||
| + | "short": "XLOVECASH" | ||
| + | }, | ||
| + | { | ||
| + | "nice": "XOnDemand", | ||
| + | "short": "XONDEMAND" | ||
| + | } | ||
| + | ] | ||
| + | </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(); | ||
| + | |||
| + | $request = Array( | ||
| + | 'method' => 'GET', | ||
| + | 'path' => 'v1/biller/partner-available', | ||
| + | '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
GET /biller/partner-available
Description
- Get available partners
Resource URL
- http://domain/api/biller/partner-available
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
None
Example Request
Method: GET
URL: http://domain/api/biller/partner-available
Response:
[
{
"nice": "Adult Friend Finder",
"short": "ADULTFRIENDFINDER"
},
{
"nice": "Adult Friend Finder API",
"short": "ADULTFRIENDFINDERAPI"
},
{
"nice": "Cams.com",
"short": "CAMS"
},
{
"nice": "CamSpot",
"short": "CAMSPOT"
},
{
"nice": "Datingfactory",
"short": "DATINGFACTORY"
},
{
"nice": "DatingGold",
"short": "DATINGGOLD"
},
{
"nice": "Effex Media",
"short": "EFFEX"
},
{
"nice": "Fling.com",
"short": "FLING"
},
{
"nice": "Flirt4Free",
"short": "FLIRT4FREE"
},
{
"nice": "GameLink",
"short": "GAMELINK"
},
{
"nice": "MallCom",
"short": "MALLCOM"
},
{
"nice": "My Dirty Hobby",
"short": "MYDIRTYHOBBY"
},
{
"nice": "Sexkey \/ Mansites",
"short": "SEXKEYMANSITES"
},
{
"nice": "SexMoney SponsorCash",
"deprecated": "1",
"short": "SEXMONEY"
},
{
"nice": "SexGoesMobile",
"short": "SGM"
},
{
"nice": "StreaMate",
"short": "STREAMATE"
},
{
"nice": "WebCamClub",
"short": "WEBCAMCLUB"
},
{
"nice": "WebCams",
"short": "WEBCAMS"
},
{
"nice": "WebCamWiz",
"short": "WEBCAMWIZ"
},
{
"nice": "Wister",
"short": "WISTER"
},
{
"nice": "XloveCash",
"short": "XLOVECASH"
},
{
"nice": "XOnDemand",
"short": "XONDEMAND"
}
]
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();
$request = Array(
'method' => 'GET',
'path' => 'v1/biller/partner-available',
'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);
?>
