Difference between revisions of "NATS5 REST API Affiliate GET soap-functions"

From TMM Wiki
Jump to navigationJump to search
(Created page with "{{NATS4 Manual | show_api_admin_section = true }} == '''GET /affiliate/soap-functions''' == '''Description''' * Get available SOAP API functions and (optionally) current perm...")
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{NATS4 Manual
+
{{NATS5 Manual
| show_api_admin_section = true
+
| show_api_admin_affiliate_section = true
 
}}
 
}}
 
== '''GET /affiliate/soap-functions''' ==
 
== '''GET /affiliate/soap-functions''' ==
 +
 
'''Description'''  
 
'''Description'''  
 
* Get available SOAP API functions and (optionally) current permissions  
 
* Get available SOAP API functions and (optionally) current permissions  
Line 9: Line 10:
 
*Replace domain with the nats domain
 
*Replace domain with the nats domain
  
'''[[NATS4_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
+
'''[[NATS5_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
 
*GET
 
*GET
 
'''Response Format'''
 
'''Response Format'''
 
*JSON
 
*JSON
  
'''[[NATS4_REST_API_Overview#Authentication|Authentication]]'''
+
'''[[NATS5_REST_API_Overview#Authentication|Authentication]]'''
 
*HTTP headers
 
*HTTP headers
  
Line 24: Line 25:
 
** optional
 
** optional
  
[[Category:NATS4_REST_APIs]]
+
== '''Example Request''' ==
[[Category:NATS4_REST_affiliate_Collection]]
+
Method: '''GET'''<br/>
 +
URL: <nowiki>http://domain/api/affiliate/soap-functions</nowiki><br/>
 +
Query String: <nowiki>loginid=3</nowiki><br/>
 +
 
 +
Response:
 +
<pre>
 +
{
 +
    "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
 +
}
 +
</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(
 +
'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);
 +
?>
 +
</pre>
 +
 
 +
[[Category:NATS5_REST_APIs]]
 +
[[Category:NATS5_REST_affiliate_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

NATS 5
Members Section
Members Management
Adding a Member
View Member Details
Restricted Values
OpenID Connect
Mod Auth OpenIDC
    Adtool
GET /adtool/admin
GET /adtool/adtools
GET /adtool/adtool
GET /adtool/adtool-rules
GET /adtool/adtool-rule
GET /adtool/categories
GET /adtool/field-options
GET /adtool/field-types
GET /adtool/groups
GET /adtool/search
GET /adtool/templates
GET /adtool/types
GET /adtool/type
POST /adtool/adtool
POST /adtool/adtool-rule
POST /adtool/category
POST /adtool/field
POST /adtool/field-option
POST /adtool/group
POST /adtool/import
POST /adtool/type
PATCH /adtool/adtool
PATCH /adtool/adtool-group
PATCH /adtool/adtool-rule
PATCH /adtool/category
PATCH /adtool/field
PATCH /adtool/field-option
PATCH /adtool/group
PATCH /adtool/move
PATCH /adtool/restore-adtool
PATCH /adtool/restore-category
PATCH /adtool/restore-field
PATCH /adtool/restore-field-option
PATCH /adtool/restore-type
PATCH /adtool/type
DELETE /adtool/adtool
DELETE /adtool/adtool-rule
DELETE /adtool/category
DELETE /adtool/field
DELETE /adtool/field-option
DELETE /adtool/group
DELETE /adtool/type
    Affiliate
DELETE /affiliate/account-rep
DELETE /affiliate/account-type
DELETE /affiliate/affiliate
DELETE /affiliate/doc
DELETE /affiliate/group
DELETE /affiliate/permissions
GET /affiliate/account-changes
GET /affiliate/account-types
GET /affiliate/admin-settings
GET /affiliate/campaigns
GET /affiliate/current
GET /affiliate/current-permissions
GET /affiliate/docs
GET /affiliate/doc
GET /affiliate/groups
GET /affiliate/group
GET /affiliate/hits
GET /affiliate/link-styles
GET /affiliate/loginids
GET /affiliate/loginlog
GET /affiliate/manual-payout
GET /affiliate/news-sections
GET /affiliate/notes
GET /affiliate/notices
GET /affiliate/override
GET /affiliate/payout
GET /affiliate/payment-periods
GET /affiliate/payvia-types
GET /affiliate/payvia-type
GET /affiliate/permissions
GET /affiliate/programcampaigns
GET /affiliate/referrer
GET /affiliate/referring-urls
GET /affiliate/reps
GET /affiliate/rest-methods
GET /affiliate/search
GET /affiliate/search-limited
GET /affiliate/settings
GET /affiliate/skins
GET /affiliate/soap-functions
GET /affiliate/status
PATCH /affiliate/adminsettings
PATCH /affiliate/account-change
PATCH /affiliate/account-type
PATCH /affiliate/account-type-permissions
PATCH /affiliate/admin-setting
PATCH /affiliate/affiliate-account-type
PATCH /affiliate/affiliate-group
PATCH /affiliate/allsettings
PATCH /affiliate/account-rep
PATCH /affiliate/avatar
PATCH /affiliate/customs
PATCH /affiliate/defaults
PATCH /affiliate/details
PATCH /affiliate/override
PATCH /affiliate/password
PATCH /affiliate/payment-period
PATCH /affiliate/payvia
PATCH /affiliate/payvia-info
PATCH /affiliate/permissions
PATCH /affiliate/referrer
PATCH /affiliate/reset-api
PATCH /affiliate/reset-rss
PATCH /affiliate/reset-tos
PATCH /affiliate/rest-permissions
PATCH /affiliate/restore
PATCH /affiliate/restore-account-type
PATCH /affiliate/settings
PATCH /affiliate/soap-permissions
PATCH /affiliate/status
POST /affiliate/account-type
POST /affiliate/add
POST /affiliate/doc
POST /affiliate/group
POST /affiliate/invoice
POST /affiliate/manual-sale
POST /affiliate/note
    Biller
GET /biller/available
GET /biller/partner-available
GET /biller/billerdata
GET /biller/cascades
GET /biller/cascades-available
GET /biller/cascade-count
GET /biller/cascade-history
GET /biller/cascade-rules
GET /biller/cascade-rule
GET /biller/cascade-step-count
GET /biller/cascade-steps
GET /biller/cascade-detail
GET /biller/cascade-list
GET /biller/count
GET /biller/detail
GET /biller/fees
GET /biller/partner-fees
GET /biller/last_poll
GET /biller/partner-last-poll
GET /biller/list
GET /biller/partner-detail
GET /biller/partner-list
GET /biller/partner-shortnames
GET /biller/process_types
GET /biller/partner-process-types
GET /biller/shortnames
GET /biller/transaction_types
GET /biller/partner-transaction-types
GET /biller/taxes
POST /biller/add
POST /biller/cascade
POST /biller/cascade-rule
POST /biller/cascade-step
POST /biller/partner
PATCH /biller/cascade
PATCH /biller/cascade-rule
PATCH /biller/cascade-step
PATCH /biller/cascade-steps-reorder
PATCH /biller/fee
PATCH /biller/partner-fee
PATCH /biller/restore
PATCH /biller/restore-cascade
PATCH /biller/restore-partner
PATCH /biller/setting
PATCH /biller/partner-setting
PATCH /biller/tax
DELETE /biller/biller
DELETE /biller/cascade
DELETE /biller/cascade-rule
DELETE /biller/cascade-step
DELETE /biller/fee
DELETE /biller/partner-fee
DELETE /biller/partner
DELETE /biller/tax
    Codes
GET /codes/affiliate-codes
GET /codes/decode
GET /codes/linkcodes
GET /codes/strack
    Config
DELETE /config/setting
GET /config/section
GET /config/sections
PATCH /config/affiliate_default
PATCH /config/section
    Include
DELETE /include/include
DELETE /include/step
GET /include/include
GET /include/includes
GET /include/templates
PATCH /include/include
PATCH /include/restore
PATCH /include/step
POST /include/include
POST /include/step
    Mailing
DELETE /mailing/mailing
DELETE /mailing/mailing-rule
DELETE /mailing/queue
GET /mailing/mailing
GET /mailing/mailings
GET /mailing/mailing-rules
GET /mailing/mailing-rule
GET /mailing/queue
GET /mailing/removelist
PATCH /mailing/mailing
PATCH /mailing/mailing-rule
PATCH /mailing/removelist
PATCH /mailing/removelist-queue
PATCH /mailing/resend-queue
PATCH /mailing/restore-queue
PATCH /mailing/send-mailing
PATCH /mailing/send-test-mailing
POST /mailing/mailing
POST /mailing/mailing-rule
POST /mailing/removelist
    Maintenance
DELETE /maintenance/log
DELETE /maintenance/cache
GET /maintenance/admin-actions
GET /maintenance/log
GET /maintenance/logs
GET /maintenance/nats
GET /maintenance/report
GET /maintenance/report-progress
GET /maintenance/reports
GET /maintenance/server
GET /maintenance/table
GET /maintenance/tables
GET /maintenance/table-clean-count
GET /maintenance/table-clean-progress
PATCH /maintenance/log
PATCH /maintenance/report
PATCH /maintenance/table
    Member
GET /member/available_flags
GET /member/encryptusername
GET /member/authstring
GET /member/details
GET /member/flags
GET /member/loginlog
GET /member/matching
GET /member/notes
GET /member/notices
GET /member/restricted-values
GET /member/search
GET /member/suggestedcanceloffers
GET /member/surfer-actions
PATCH /member/details
PATCH /member/expiration
PATCH /member/expiremanual
PATCH /member/resend-transaction-email
PATCH /member/resend-transaction-postback
PATCH /member/restricted-value
PATCH /member/forget
PATCH /member/lock
PATCH /member/unlock
POST /member/flag
POST /member/login
POST /member/note
POST /member/restricted-value
DELETE /member/flag
DELETE /member/restricted-value
    Message
DELETE /message/message
DELETE /message/permanent
GET /message/count
GET /message/messages
GET /message/view
PATCH /message/read
PATCH /message/unread
PATCH /message/undelete
POST /message/message
    News
DELETE /news/entry
DELETE /news/section
GET /news/entry
GET /news/news
GET /news/sections
PATCH /news/entry
POST /news/entry
POST /news/section
    Notification
DELETE /notification/notification
DELETE /notification/permanent
GET /notification/count
GET /notification/notifications
GET /notification/view
PATCH /notification/read
PATCH /notification/unread
PATCH /notification/undelete
    Option
GET /option/options
GET /option/rule
PATCH /option/rule
PATCH /option/text
POST /option/rule
    Payment
DELETE /payment/invoice
DELETE /payment/payout-period
DELETE /payment/payvia-field
DELETE /payment/payvia-field-mc
DELETE /payment/payvia-rule
GET /payment/dump-format
GET /payment/dump-formats
GET /payment/invoices
GET /payment/payments
GET /payment/payment-dumps
GET /payment/payment-dump
GET /payment/payment-search
GET /payment/payvia
GET /payment/payvias
GET /payment/payvia-fields
GET /payment/payvia-field-mcs
GET /payment/payout-period
GET /payment/payout-periods
GET /payment/payvia-rules
GET /payment/payvia-rule
GET /payment/payviarule
PATCH /payment/copy-dump-format
PATCH /payment/default-payout-period
PATCH /payment/dump-format
PATCH /payment/duplicate-payvia
PATCH /payment/invoice
PATCH /payment/payment
PATCH /payment/payment-paid
PATCH /payment/payment-store
PATCH /payment/payment-unstore
PATCH /payment/payments
PATCH /payment/payments-unstore
PATCH /payment/payout-period
PATCH /payment/payout-period-affiliates
PATCH /payment/payvia
PATCH /payment/payvia-field
PATCH /payment/payvia-fields-reorder
PATCH /payment/payvia-field-mc
PATCH /payment/payvia-field-mcs-reorder
PATCH /payment/payvia-rule
PATCH /payment/payviarule
PATCH /payment/restore-payout-period
PATCH /payment/restore-payvia-field
PATCH /payment/restore-payvia-field-mc
POST /payment/check-dump
POST /payment/dump-format
POST /payment/import-dump
POST /payment/invoice
POST /payment/payout-period
POST /payment/payvia
POST /payment/payvia-field
POST /payment/payvia-field-mc
POST /payment/payvia-rule
    Program
DELETE /program/program
DELETE /program/payout-change
DELETE /program/payout-change-tier
GET /program/additional-payout-change-targets
GET /program/affiliate-available
GET /program/detail
GET /program/list
GET /program/options
GET /program/payout-changes
GET /program/redirect-available
GET /program/sites
GET /program/tours
GET /program/types
PATCH /program/default_payout
PATCH /program/details
PATCH /program/disable_affiliate
PATCH /program/disable_tour
PATCH /program/enable_affiliate
PATCH /program/enable_site
PATCH /program/enable_tour
PATCH /program/move-payout-change
PATCH /program/payout-change
PATCH /program/payout-change-tier
POST /program/new
POST /program/payout-change
POST /program/payout-change-tier
    Report
GET /report/affiliate-ratios
GET /report/hits
GET /report/hit-totals
GET /report/profitloss
GET /report/profit-loss
GET /report/fields
GET /report/focus
GET /report/focuses
GET /report/groups
GET /report/perspective
GET /report/perspectives
GET /report/report
GET /report/subscription
GET /report/surfer
GET /report/surferaction
GET /report/transactionpayouts
GET /report/transactions
GET /report/transaction
GET /report/report-widget
GET /report/widgets
GET /report/widget
GET /report/widget-info
GET /report/views
POST /report/focus
POST /report/group
POST /report/perspective
PATCH /report/focus
PATCH /report/focus-enabled
PATCH /report/focus-default
PATCH /report/focuses-reorder
PATCH /report/perspective
PATCH /report/perspective-group
PATCH /report/report-widget
PATCH /report/widget
DELETE /report/focus
    Reward
DELETE /reward/category
DELETE /reward/purchase
DELETE /reward/point
DELETE /reward/reward
GET /reward/categories
GET /reward/points
GET /reward/purchases
GET /reward/rewards
PATCH /reward/move-point
PATCH /reward/point
PATCH /reward/reward
PATCH /reward/ship-purchase
PATCH /reward/unship-purchase
POST /reward/category
POST /reward/point
POST /reward/reward
    Service
GET /service/check-functions
GET /service/condition
GET /service/countries
GET /service/country
GET /service/datetime
GET /service/languages
GET /service/periods
GET /service/ping
GET /service/project
GET /service/rule-condition-data
GET /service/rule-info
GET /service/stats-breakdowns
GET /service/timezone
GET /service/timestamp
POST /service/sendemail
    Site
GET /site/base-templates
GET /site/billers
GET /site/cookies
GET /site/coupon
GET /site/coupons
GET /site/coupon-revisions
GET /site/email-settings
GET /site/groups
GET /site/option
GET /site/options
GET /site/options-available
GET /site/option-fields
GET /site/option-rules
GET /site/option-rule
GET /site/option-type
GET /site/option-types
GET /site/programs
GET /site/redirect
GET /site/redirects
GET /site/redirect-rules
GET /site/redirect-rule
GET /site/site-list
GET /site/site
GET /site/site-notices
GET /site/site-partner
GET /site/site-partners
GET /site/site-type
GET /site/sites
GET /site/template
GET /site/templates
GET /site/template-sections
GET /site/template-sites
GET /site/tour
GET /site/tours
GET /site/tour-emails
GET /site/tour-notices
POST /site/coupon
POST /site/group
POST /site/option
POST /site/option-rule
POST /site/redirect
POST /site/redirect-rule
POST /site/site-partner
POST /site/site-tour
POST /site/copy-template
POST /site/tour
PATCH /site/cookie
PATCH /site/coupon
PATCH /site/duplicate-option
PATCH /site/email-settings
PATCH /site/group
PATCH /site/move
PATCH /site/option
PATCH /site/option-rule
PATCH /site/redirect
PATCH /site/redirect-rule
PATCH /site/reset-coupon
PATCH /site/restore-group
PATCH /site/restore-option
PATCH /site/restore-redirect
PATCH /site/restore-site
PATCH /site/restore-site-partner
PATCH /site/restore-tour
PATCH /site/site
PATCH /site/site-partner
PATCH /site/template
PATCH /site/tour
DELETE /site/cookie
DELETE /site/group
DELETE /site/option
DELETE /site/option-rule
DELETE /site/site
DELETE /site/site-partner
DELETE /site/redirect
DELETE /site/redirect-rule
DELETE /site/template
DELETE /site/tour
DELETE /site/tour-field
    Skin
DELETE /skin/skin
DELETE /skin/template
GET /skin/colors
GET /skin/export
GET /skin/skins
GET /skin/sections
GET /skin/templates
GET /skin/template
PATCH /skin/colors
PATCH /skin/flush
PATCH /skin/skin
PATCH /skin/template
POST /skin/copy-template
POST /skin/import
POST /skin/skin
POST /skin/template

GET /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

Request Method

  • GET

Response Format

  • JSON

Authentication

  • 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);
?>