Difference between revisions of "NATS5 REST API Affiliate GET settings"
From TMM Wiki
Jump to navigationJump to searchLine 1: | Line 1: | ||
{{NATS5 Manual | {{NATS5 Manual | ||
− | | | + | | show_api_admin_affiliate_section = true |
}} | }} | ||
== '''GET /affiliate/settings''' == | == '''GET /affiliate/settings''' == |
Latest revision as of 15:58, 9 August 2019
GET /affiliate/settings
Description
- Get settings for an affiliate
Resource URL
- http://domain/api/affiliate/settings
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- loginid
- type: digit
- required
- set_group
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional
- prefix
- type: string
- optional
Example Request
Method: GET
URL: http://domain/api/affiliate/settings
Query String: loginid=3&set_group=0
Response:
{ "success": true, "settings": [ { "settingid": "1", "set_name": "unencoded", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "2", "set_name": "startpage", "advanced": "1", "set_group": "0", "skin_setting_group": "0", "default": "", "custom": 0, "set_value": "" }, { "settingid": "3", "set_name": "live_update_defaults", "advanced": "0", "set_group": "0", "skin_setting_group": "1", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "169", "set_name": "default_minimize_page_description", "advanced": "0", "set_group": "0", "skin_setting_group": "2", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "258", "set_name": "affiliate_contact1", "advanced": "1", "set_group": "0", "skin_setting_group": "0", "default": "", "custom": 0, "set_value": "" }, { "settingid": "259", "set_name": "affiliate_contact2", "advanced": "1", "set_group": "0", "skin_setting_group": "0", "default": "", "custom": 0, "set_value": "" }, { "settingid": "260", "set_name": "affiliate_contact3", "advanced": "1", "set_group": "0", "skin_setting_group": "0", "default": "", "custom": 0, "set_value": "" }, { "settingid": "261", "set_name": "affiliate_contact4", "advanced": "1", "set_group": "0", "skin_setting_group": "0", "default": "", "custom": 0, "set_value": "" }, { "settingid": "262", "set_name": "affiliate_contact5", "advanced": "1", "set_group": "0", "skin_setting_group": "0", "default": "", "custom": 0, "set_value": "" }, { "settingid": "266", "set_name": "post_member_approval_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 1, "custom": 0, "set_value": 1 }, { "settingid": "267", "set_name": "post_member_rebill_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 1, "custom": 0, "set_value": 1 }, { "settingid": "268", "set_name": "post_member_upgrade_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 1, "custom": 0, "set_value": 1 }, { "settingid": "269", "set_name": "post_member_expire_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 1, "custom": 0, "set_value": 1 }, { "settingid": "270", "set_name": "post_member_insufficient_fund_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 1, "custom": 0, "set_value": 1 }, { "settingid": "271", "set_name": "post_member_credit_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 1, "custom": 0, "set_value": 1 }, { "settingid": "272", "set_name": "post_member_chargeback_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 1, "custom": 0, "set_value": 1 }, { "settingid": "273", "set_name": "post_member_void_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 1, "custom": 0, "set_value": 1 }, { "settingid": "274", "set_name": "post_member_upgradedeny_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 1, "custom": 0, "set_value": 1 }, { "settingid": "275", "set_name": "post_member_change_details_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 1, "custom": 0, "set_value": 1 }, { "settingid": "276", "set_name": "post_member_void_reversal_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 1, "custom": 0, "set_value": 1 }, { "settingid": "277", "set_name": "post_member_credit_reversal_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 1, "custom": 0, "set_value": 1 }, { "settingid": "278", "set_name": "post_member_chargeback_reversal_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 1, "custom": 0, "set_value": 1 }, { "settingid": "279", "set_name": "post_member_insufficient_reversal_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "280", "set_name": "post_member_pre_approval_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 1, "custom": 0, "set_value": 1 }, { "settingid": "281", "set_name": "post_member_pre_rebill_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 1, "custom": 0, "set_value": 1 }, { "settingid": "282", "set_name": "post_member_pending_approval_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 1, "custom": 0, "set_value": 1 }, { "settingid": "283", "set_name": "post_member_pending_rebill_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 1, "custom": 0, "set_value": 1 }, { "settingid": "284", "set_name": "post_member_perminute_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "285", "set_name": "post_member_perminute_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 1, "custom": 0, "set_value": 1 }, { "settingid": "286", "set_name": "post_member_seconds_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "287", "set_name": "post_member_seconds_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 1, "custom": 0, "set_value": 1 }, { "settingid": "288", "set_name": "post_member_initial_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "289", "set_name": "post_member_initial_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 1, "custom": 0, "set_value": 1 }, { "settingid": "290", "set_name": "post_member_trial_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "291", "set_name": "post_member_trial_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 1, "custom": 0, "set_value": 1 }, { "settingid": "292", "set_name": "post_member_insufficient_funds_reversal_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "293", "set_name": "post_member_insufficient_funds_reversal_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 1, "custom": 0, "set_value": 1 }, { "settingid": "294", "set_name": "post_member_pending_ncr_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "295", "set_name": "post_member_pending_ncr_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 1, "custom": 0, "set_value": 1 }, { "settingid": "296", "set_name": "post_extra_vars_campaignid_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "297", "set_name": "post_extra_vars_programid_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "298", "set_name": "post_extra_vars_siteid_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "299", "set_name": "post_extra_vars_tourid_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "300", "set_name": "post_extra_vars_optionid_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "301", "set_name": "post_extra_vars_adtoolid_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "302", "set_name": "post_extra_vars_subid1_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "303", "set_name": "post_extra_vars_subid2_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "304", "set_name": "post_extra_vars_billerid_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "305", "set_name": "post_extra_vars_countryid_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "306", "set_name": "post_extra_vars_promotionalid_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "307", "set_name": "post_extra_vars_campaignid_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "308", "set_name": "post_extra_vars_programid_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "309", "set_name": "post_extra_vars_siteid_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "310", "set_name": "post_extra_vars_tourid_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "311", "set_name": "post_extra_vars_optionid_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "312", "set_name": "post_extra_vars_adtoolid_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "313", "set_name": "post_extra_vars_subid1_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "314", "set_name": "post_extra_vars_subid2_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "315", "set_name": "post_extra_vars_billerid_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "316", "set_name": "post_extra_vars_countryid_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "317", "set_name": "post_extra_vars_promotionalid_disallow", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "318", "set_name": "post_member_approval_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "319", "set_name": "post_member_rebill_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "320", "set_name": "post_member_upgrade_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "321", "set_name": "post_member_expire_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "322", "set_name": "post_member_insufficient_fund_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "323", "set_name": "post_member_credit_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "324", "set_name": "post_member_chargeback_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "325", "set_name": "post_member_void_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "326", "set_name": "post_member_upgradedeny_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "327", "set_name": "post_member_change_details_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "328", "set_name": "post_member_void_reversal_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "329", "set_name": "post_member_credit_reversal_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "330", "set_name": "post_member_chargeback_reversal_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "331", "set_name": "post_member_insufficient_reversal_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "332", "set_name": "post_member_pre_approval_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "333", "set_name": "post_member_pre_rebill_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "334", "set_name": "post_member_pending_approval_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 }, { "settingid": "335", "set_name": "post_member_pending_rebill_allowed", "advanced": "0", "set_group": "0", "skin_setting_group": "0", "default": 0, "custom": 0, "set_value": 0 } ] }
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( 'loginid' => '3', 'set_group' => '0', ); $request = Array( 'method' => 'GET', 'path' => 'v1/affiliate/settings', '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); ?>