NATS5 REST API Affiliate GET soap-functions
From TMM Wiki
(Redirected from NATS4 REST API Affiliate GET soap-functions)
Jump to navigationJump to searchGET /affiliate/soap-functions
Description
- Get available SOAP API functions and (optionally) current permissions
Resource URL
- http://domain/api/affiliate/soap-functions
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- loginid
- optional
Example Request
Method: GET
URL: http://domain/api/affiliate/soap-functions
Query String: loginid=3
Response:
{
"available": [
"add_affs",
"add_manual_member",
"add_membership_note",
"add_option_rule",
"admin_get_adtools",
"adtool_categories",
"adtool_types",
"aff_getcampaigns",
"decode_natscode",
"edit_option_rule",
"edit_option_text",
"expire_manual_member",
"get_affiliate_campaigns",
"get_affiliate_hit_data",
"get_affiliate_loginids",
"get_affiliate_nats_codes",
"get_affiliate_payout",
"get_affiliate_program_campaign_list",
"get_biller_information",
"get_biller_member_details",
"get_cascades",
"get_member_cancel_string",
"get_member_details",
"get_member_instant_upgrade_string",
"get_member_package_upgrade_string",
"get_member_signupplus_string",
"get_member_token_rebuy_string",
"get_member_upsell_string",
"get_option_rule",
"get_options",
"get_payment_data",
"get_payvia_rule",
"get_profit_loss_report",
"get_suggested_cancel_offers",
"import_adtools_dump",
"ping",
"record_member_login",
"search_affiliate_info",
"search_member_info",
"send_email",
"set_aff_admin_settings",
"set_aff_customs",
"set_aff_defaults",
"set_aff_informations",
"set_aff_payvia_info",
"set_aff_settings",
"set_member_details",
"set_member_expiration",
"set_member_rebill_date",
"set_payment_status",
"set_payvia_rule",
"update_member_status"
],
"restricted": [],
"unrestricted": [
"add_affs",
"add_manual_member",
"add_membership_note",
"add_option_rule",
"admin_get_adtools",
"adtool_categories",
"adtool_types",
"aff_getcampaigns",
"decode_natscode",
"edit_option_rule",
"edit_option_text",
"expire_manual_member",
"get_affiliate_campaigns",
"get_affiliate_hit_data",
"get_affiliate_loginids",
"get_affiliate_nats_codes",
"get_affiliate_payout",
"get_affiliate_program_campaign_list",
"get_biller_information",
"get_biller_member_details",
"get_cascades",
"get_member_cancel_string",
"get_member_details",
"get_member_instant_upgrade_string",
"get_member_package_upgrade_string",
"get_member_signupplus_string",
"get_member_token_rebuy_string",
"get_member_upsell_string",
"get_option_rule",
"get_options",
"get_payment_data",
"get_payvia_rule",
"get_profit_loss_report",
"get_suggested_cancel_offers",
"import_adtools_dump",
"ping",
"record_member_login",
"search_affiliate_info",
"search_member_info",
"send_email",
"set_aff_admin_settings",
"set_aff_customs",
"set_aff_defaults",
"set_aff_informations",
"set_aff_payvia_info",
"set_aff_settings",
"set_member_details",
"set_member_expiration",
"set_member_rebill_date",
"set_payment_status",
"set_payvia_rule",
"update_member_status"
],
"permissions": [
{
"function": "add_affs",
"enabled": 1
},
{
"function": "add_manual_member",
"enabled": 1
},
{
"function": "add_membership_note",
"enabled": 1
},
{
"function": "add_option_rule",
"enabled": 1
},
{
"function": "admin_get_adtools",
"enabled": 1
},
{
"function": "adtool_categories",
"enabled": 1
},
{
"function": "adtool_types",
"enabled": 1
},
{
"function": "aff_getcampaigns",
"enabled": 1
},
{
"function": "decode_natscode",
"enabled": 1
},
{
"function": "edit_option_rule",
"enabled": 1
},
{
"function": "edit_option_text",
"enabled": 1
},
{
"function": "expire_manual_member",
"enabled": 1
},
{
"function": "get_affiliate_campaigns",
"enabled": 1
},
{
"function": "get_affiliate_hit_data",
"enabled": 1
},
{
"function": "get_affiliate_loginids",
"enabled": 1
},
{
"function": "get_affiliate_nats_codes",
"enabled": 1
},
{
"function": "get_affiliate_payout",
"enabled": 1
},
{
"function": "get_affiliate_program_campaign_list",
"enabled": 1
},
{
"function": "get_biller_information",
"enabled": 1
},
{
"function": "get_biller_member_details",
"enabled": 1
},
{
"function": "get_cascades",
"enabled": 1
},
{
"function": "get_member_cancel_string",
"enabled": 1
},
{
"function": "get_member_details",
"enabled": 1
},
{
"function": "get_member_instant_upgrade_string",
"enabled": 1
},
{
"function": "get_member_package_upgrade_string",
"enabled": 1
},
{
"function": "get_member_signupplus_string",
"enabled": 1
},
{
"function": "get_member_token_rebuy_string",
"enabled": 1
},
{
"function": "get_member_upsell_string",
"enabled": 1
},
{
"function": "get_option_rule",
"enabled": 1
},
{
"function": "get_options",
"enabled": 1
},
{
"function": "get_payment_data",
"enabled": 1
},
{
"function": "get_payvia_rule",
"enabled": 1
},
{
"function": "get_profit_loss_report",
"enabled": 1
},
{
"function": "get_suggested_cancel_offers",
"enabled": 1
},
{
"function": "import_adtools_dump",
"enabled": 1
},
{
"function": "ping",
"enabled": 1
},
{
"function": "record_member_login",
"enabled": 1
},
{
"function": "search_affiliate_info",
"enabled": 1
},
{
"function": "search_member_info",
"enabled": 1
},
{
"function": "send_email",
"enabled": 1
},
{
"function": "set_aff_admin_settings",
"enabled": 1
},
{
"function": "set_aff_customs",
"enabled": 1
},
{
"function": "set_aff_defaults",
"enabled": 1
},
{
"function": "set_aff_informations",
"enabled": 1
},
{
"function": "set_aff_payvia_info",
"enabled": 1
},
{
"function": "set_aff_settings",
"enabled": 1
},
{
"function": "set_member_details",
"enabled": 1
},
{
"function": "set_member_expiration",
"enabled": 1
},
{
"function": "set_member_rebill_date",
"enabled": 1
},
{
"function": "set_payment_status",
"enabled": 1
},
{
"function": "set_payvia_rule",
"enabled": 1
},
{
"function": "update_member_status",
"enabled": 1
}
],
"success": true
}
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',
);
$request = Array(
'method' => 'GET',
'path' => 'v1/affiliate/soap-functions',
'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);
?>
