Difference between revisions of "NATS5 REST API Program GET list"
From TMM Wiki
Jump to navigationJump to search| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_program_section = true |
}} | }} | ||
== '''GET /program/list''' == | == '''GET /program/list''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get a list of programs | * Get a list of programs | ||
| 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 31: | Line 32: | ||
** optional | ** optional | ||
* '''hide_import_program''' | * '''hide_import_program''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional (default value: 1) | ** optional (default value: 1) | ||
* '''loginid''' | * '''loginid''' | ||
| Line 40: | Line 41: | ||
** optional | ** optional | ||
* '''return_affiliate_disabled''' | * '''return_affiliate_disabled''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
| + | == '''Example Request''' == | ||
| + | Method: '''GET'''<br/> | ||
| + | URL: <nowiki>http://domain/api/program/list</nowiki><br/> | ||
| + | Query String: <nowiki>enabled=1&type=0&has_payout_changes=1&hide_import_program=1&loginid=1&return_affiliate_disabled=1</nowiki><br/> | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | [ | ||
| + | { | ||
| + | "programid": "2", | ||
| + | "program": "test", | ||
| + | "hidden": "0", | ||
| + | "type": "0", | ||
| + | "name": "testprogram", | ||
| + | "extended_payout": "", | ||
| + | "description": "", | ||
| + | "enabled": 1, | ||
| + | "resellers_enabled": "0", | ||
| + | "resellers_disabled": 4, | ||
| + | "payouts": [], | ||
| + | "affiliate_enabled": 0, | ||
| + | "has_payout_changes": 0, | ||
| + | "type_name": "Standard Program" | ||
| + | } | ||
| + | ] | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
== '''Example Code''' == | == '''Example Code''' == | ||
| Line 56: | Line 86: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| − | $data = | + | $data = Array( |
| − | + | 'enabled' => 1, | |
| + | 'type' => 0, | ||
| + | 'has_payout_changes' => 1, | ||
| + | 'hide_import_program' => 1, | ||
| + | 'loginid' => '1', | ||
| + | 'return_affiliate_disabled' => 1, | ||
); | ); | ||
| Line 99: | Line 134: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_program_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 16:00, 9 August 2019
GET /program/list
Description
- Get a list of programs
Resource URL
- http://domain/api/program/list
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- enabled
- type: trinary_digit (0, 1, or 2)
- optional
- type
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional
- has_payout_changes
- type: trinary_digit (0, 1, or 2)
- optional
- hide_import_program
- type: boolean_digit (0 or 1)
- optional (default value: 1)
- loginid
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional
- username
- type: string
- optional
- return_affiliate_disabled
- type: boolean_digit (0 or 1)
- optional
Example Request
Method: GET
URL: http://domain/api/program/list
Query String: enabled=1&type=0&has_payout_changes=1&hide_import_program=1&loginid=1&return_affiliate_disabled=1
Response:
[
{
"programid": "2",
"program": "test",
"hidden": "0",
"type": "0",
"name": "testprogram",
"extended_payout": "",
"description": "",
"enabled": 1,
"resellers_enabled": "0",
"resellers_disabled": 4,
"payouts": [],
"affiliate_enabled": 0,
"has_payout_changes": 0,
"type_name": "Standard Program"
}
]
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(
'enabled' => 1,
'type' => 0,
'has_payout_changes' => 1,
'hide_import_program' => 1,
'loginid' => '1',
'return_affiliate_disabled' => 1,
);
$request = Array(
'method' => 'GET',
'path' => 'v1/program/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);
?>
