Difference between revisions of "NATS5 REST API Affiliate GET current-permissions"

From TMM Wiki
Jump to navigationJump to search
 
(3 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/current-permissions''' ==
 
== '''GET /affiliate/current-permissions''' ==
 +
 
'''Description'''  
 
'''Description'''  
 
* Get the permissions for your user account  
 
* Get the permissions for your user account  
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 20: Line 21:
  
 
None
 
None
 +
== '''Example Request''' ==
 +
Method: '''GET'''<br/>
 +
URL: <nowiki>http://domain/api/affiliate/current-permissions</nowiki><br/>
 +
 +
Response:
 +
<pre>
 +
{
 +
    "success": true,
 +
    "permissions": {
 +
        "overview": {
 +
            "display": true,
 +
            "all_views": true,
 +
            "all_actions": true,
 +
            "editable": true,
 +
            "some_views": true,
 +
            "view": {
 +
                "default": true,
 +
                "mobile_affiliates": true,
 +
                "mobile_all": true,
 +
                "mobile_new_affiliates": true,
 +
                "mobile_new_members": true,
 +
                "mobile_programs": true,
 +
                "mobile_sites": true,
 +
                "mobile_summary": true,
 +
                "original": true
 +
            }
 +
        },
 +
        "adtools": {
 +
            "display": true,
 +
            "all_views": true,
 +
            "all_actions": true,
 +
            "editable": true,
 +
            "some_views": true,
 +
            "view": {
 +
                "bulk": true,
 +
                "bulk_update": true,
 +
                "adtools": true,
 +
                "edit": true,
 +
                "edit_rule": true,
 +
                "edit_type": true,
 +
                "group": true,
 +
                "search": true,
 +
                "set_cotd_content": true,
 +
                "set_gbcontent": true,
 +
                "set_gbtemplates": true,
 +
                "stop_bulk": true
 +
            },
 +
            "some_actions": true,
 +
            "action": {
 +
                "add_cotd_content": true,
 +
                "add_category": true,
 +
                "add_assoc": true,
 +
                "add_type_field_mc_option": true,
 +
                "add_new_group": true,
 +
                "add_rule": true,
 +
                "add_type": true,
 +
                "add_type_field": true,
 +
                "bulk_import": true,
 +
                "bulk_update": true,
 +
                "move": true,
 +
                "delete_cotd_content": true,
 +
                "delete_category": true,
 +
                "delete_group": true,
 +
                "delete_mc_option": true,
 +
                "delete_type": true,
 +
                "delete_type_field": true,
 +
                "disable_adtool": true,
 +
                "disable_cotd_content": true,
 +
                "disable_rule": true,
 +
                "edit_adtool": true,
 +
                "edit_category": true,
 +
                "edit_group": true,
 +
                "edit_mc_option": true,
 +
                "edit_rule": true,
 +
                "edit_type": true,
 +
                "edit_type_field": true,
 +
                "enable_adtool": true,
 +
                "enable_cotd_content": true,
 +
                "new_adtool": true,
 +
                "remove_assoc": true,
 +
                "set_cotd_current_content": true,
 +
                "set_gbmatches": true,
 +
                "sort": true,
 +
                "undelete_category": true,
 +
                "undelete_mc_option": true,
 +
                "undelete_type": true,
 +
                "undelete_type_field": true
 +
            }
 +
        },
 +
        "affiliates": {
 +
            "display": true,
 +
            "all_views": true,
 +
            "all_actions": true,
 +
            "editable": true,
 +
            "some_views": true,
 +
            "view": {
 +
                "add_sale": true,
 +
                "account_access": true,
 +
                "account_changes": true,
 +
                "affiliate_documents": true,
 +
                "affiliate_overview": true,
 +
                "affiliate_payout_period": true,
 +
                "affiliate_twofactor": true,
 +
                "loginlog": true,
 +
                "affiliate_approve": true,
 +
                "change_pass": true,
 +
                "affiliate_edit": true,
 +
                "manual_invoices": true,
 +
                "affiliate_status": true,
 +
                "email_csv_dump": true
 +
            },
 +
            "some_actions": true,
 +
            "action": {
 +
                "document_add": true,
 +
                "invoice_add": true,
 +
                "add_sale": true,
 +
                "note_new": true,
 +
                "add_affiliate": true,
 +
                "access_custom": true,
 +
                "affiliate_twofactor": true,
 +
                "account_changes": true,
 +
                "approve_deny": true,
 +
                "access_save": true,
 +
                "affiliate_change_api_key": true,
 +
                "change_pass": true,
 +
                "affiliate_delete": true,
 +
                "document_delete": true,
 +
                "invoice_delete": true,
 +
                "document_get": true,
 +
                "edit_save": true,
 +
                "invoice_edit": true,
 +
                "payout_period_enable": true,
 +
                "affiliate_clear_rep": true,
 +
                "affiliate_clear_referrer": true,
 +
                "affiliate_restore": true,
 +
                "affiliate_assign_rep": true,
 +
                "set_payout_period": true,
 +
                "update_status": true,
 +
                "affiliate_assign_ref": true
 +
            }
 +
        },
 +
        "billers": {
 +
            "display": true,
 +
            "all_views": true,
 +
            "all_actions": true,
 +
            "editable": true,
 +
            "some_views": true,
 +
            "view": {
 +
                "add_cascade": true,
 +
                "biller_charges": true,
 +
                "tax": true,
 +
                "cascade_rules": true,
 +
                "poll_status": true
 +
            },
 +
            "some_actions": true,
 +
            "action": {
 +
                "add_biller": true,
 +
                "add_cascade": true,
 +
                "add_cascade_rule": true,
 +
                "set_tax": true,
 +
                "delete_biller": true,
 +
                "delete_biller_charge": true,
 +
                "delete_cascade": true,
 +
                "delete_cascade_step": true,
 +
                "delete_tax": true,
 +
                "disable_cascade_rule": true,
 +
                "edit_biller": true,
 +
                "edit_cascade": true,
 +
                "edit_cascade_rule": true,
 +
                "edit_cascade_step": true,
 +
                "down_cascade_step": true,
 +
                "up_cascade_step": true,
 +
                "new_cascade_step": true,
 +
                "set_biller_charge": true,
 +
                "restore_biller": true,
 +
                "restore_cascade": true
 +
            }
 +
        },
 +
        "commissions": {
 +
            "display": true,
 +
            "all_views": true,
 +
            "all_actions": true,
 +
            "editable": true,
 +
            "some_views": true,
 +
            "view": {
 +
                "add": true,
 +
                "edit_change": true,
 +
                "changes": true
 +
            },
 +
            "some_actions": true,
 +
            "action": {
 +
                "add": true,
 +
                "add_tier": true,
 +
                "delete_change": true,
 +
                "delete_tier": true,
 +
                "edit": true,
 +
                "move": true,
 +
                "save_change": true,
 +
                "save_tier": true
 +
            }
 +
        },
 +
        "config": {
 +
            "display": true,
 +
            "all_views": true,
 +
            "all_actions": true,
 +
            "editable": true,
 +
            "some_views": true,
 +
            "view": {
 +
                "affiliate_default_settings": true,
 +
                "affiliates": true,
 +
                "currency - all": true,
 +
                "billers": true,
 +
                "cronjobs": true,
 +
                "display": true,
 +
                "emails": true,
 +
                "external programs": true,
 +
                "fraud": true,
 +
                "logging": true,
 +
                "home": true,
 +
                "misc": true,
 +
                "notifications": true,
 +
                "postback": true,
 +
                "security": true,
 +
                "surfer": true,
 +
                "third party": true,
 +
                "currency - used": true
 +
            },
 +
            "some_actions": true,
 +
            "action": {
 +
                "revert": true,
 +
                "save": true,
 +
                "update_affiliates": true
 +
            }
 +
        },
 +
        "global": {
 +
            "editable": true,
 +
            "some_actions": true,
 +
            "action": {
 +
                "edit_affiliate": true,
 +
                "restrict_member_view": false
 +
            },
 +
            "setting": {
 +
                "affiliate_override": {
 +
                    "disabled": false,
 +
                    "all_affiliates": true,
 +
                    "my_affiliates": false,
 +
                    "my_network": false
 +
                }
 +
            }
 +
        },
 +
        "includes": {
 +
            "display": true,
 +
            "all_views": true,
 +
            "all_actions": true,
 +
            "editable": true,
 +
            "some_views": true,
 +
            "view": {
 +
                "edit_chain": true,
 +
                "edit_rule": true,
 +
                "edit_step": true,
 +
                "rules": true,
 +
                "steps": true
 +
            },
 +
            "some_actions": true,
 +
            "action": {
 +
                "add": true,
 +
                "add_rule": true,
 +
                "add_step": true,
 +
                "delete": true,
 +
                "delete_rule": true,
 +
                "delete_step": true,
 +
                "edit": true,
 +
                "edit_rule": true,
 +
                "edit_step": true,
 +
                "undelete": true,
 +
                "undelete_step": true
 +
            }
 +
        },
 +
        "codes": {
 +
            "display": true,
 +
            "all_views": true,
 +
            "all_actions": true,
 +
            "editable": true,
 +
            "some_views": true,
 +
            "view": {
 +
                "links": true,
 +
                "strack": true
 +
            },
 +
            "some_actions": false
 +
        },
 +
        "logging": {
 +
            "display": true,
 +
            "all_views": true,
 +
            "all_actions": true,
 +
            "editable": true,
 +
            "some_views": true,
 +
            "view": {
 +
                "admin_actions": true,
 +
                "view_log": true
 +
            },
 +
            "some_actions": true,
 +
            "action": {
 +
                "search_log": true
 +
            }
 +
        },
 +
        "mails": {
 +
            "display": true,
 +
            "all_views": true,
 +
            "all_actions": true,
 +
            "editable": true,
 +
            "some_views": true,
 +
            "view": {
 +
                "queue": true,
 +
                "remove": true,
 +
                "mail": true
 +
            },
 +
            "some_actions": true,
 +
            "action": {
 +
                "add": true,
 +
                "add_rule": true,
 +
                "delete": true,
 +
                "delete_queue_mail": true,
 +
                "disable_rule": true,
 +
                "edit": true,
 +
                "edit_rule": true,
 +
                "removelist_save": true,
 +
                "reset": true,
 +
                "undelete_queue_mail": true,
 +
                "retry_queue_mail": true,
 +
                "send": true,
 +
                "send_test": true
 +
            }
 +
        },
 +
        "cleanup": {
 +
            "display": true,
 +
            "all_views": true,
 +
            "all_actions": true,
 +
            "editable": true,
 +
            "some_views": true,
 +
            "view": {
 +
                "clean_log": true,
 +
                "clean_table": true,
 +
                "cron": true,
 +
                "errors": true,
 +
                "fix_error": true,
 +
                "logs": true,
 +
                "status": true,
 +
                "reports": true,
 +
                "build_report": true,
 +
                "view_table": true
 +
            },
 +
            "some_actions": true,
 +
            "action": {
 +
                "build_report": true,
 +
                "clean_log": true,
 +
                "remove_log": true,
 +
                "clean_table": true,
 +
                "clear_cache": true,
 +
                "remove_error": true,
 +
                "resolve_error": true
 +
            }
 +
        },
 +
        "members": {
 +
            "display": true,
 +
            "all_views": true,
 +
            "all_actions": true,
 +
            "editable": true,
 +
            "some_views": true,
 +
            "view": {
 +
                "add": true,
 +
                "edit": true,
 +
                "member": true,
 +
                "email_csv_dump": true,
 +
                "full_csv_dump": true
 +
            },
 +
            "some_actions": true,
 +
            "action": {
 +
                "add": true,
 +
                "new_note": true,
 +
                "delete": true,
 +
                "delete_note": true,
 +
                "edit": true,
 +
                "lock_member": true,
 +
                "mark": true,
 +
                "unlock_member": true
 +
            }
 +
        },
 +
        "network": {
 +
            "display": true,
 +
            "all_views": true,
 +
            "all_actions": true,
 +
            "editable": true,
 +
            "some_views": false,
 +
            "some_actions": true,
 +
            "action": {
 +
                "add_network": true,
 +
                "save_changes": true
 +
            }
 +
        },
 +
        "news": {
 +
            "display": true,
 +
            "all_views": true,
 +
            "all_actions": true,
 +
            "editable": true,
 +
            "some_views": true,
 +
            "view": {
 +
                "new_news": true,
 +
                "edit": true,
 +
                "notifications": true,
 +
                "reply_message": true,
 +
                "send_message": true,
 +
                "send_note": true,
 +
                "messages": true,
 +
                "view": true,
 +
                "view_note": true
 +
            },
 +
            "some_actions": true,
 +
            "action": {
 +
                "add": true,
 +
                "add_section": true,
 +
                "delete_all": true,
 +
                "delete": true,
 +
                "delete_note": true,
 +
                "del_section": true,
 +
                "edit": true,
 +
                "mark_all_read": true,
 +
                "mark_all_unread": true,
 +
                "unviewed": true,
 +
                "viewed": true,
 +
                "reply_message": true,
 +
                "undelete_all": true,
 +
                "send_message": true,
 +
                "send_note": true,
 +
                "undelete_note": true
 +
            }
 +
        },
 +
        "payments": {
 +
            "display": true,
 +
            "all_views": true,
 +
            "all_actions": true,
 +
            "editable": true,
 +
            "some_views": true,
 +
            "view": {
 +
                "edit_dump": true,
 +
                "edit_payvia_field_mc": true,
 +
                "edit_open_payments": true,
 +
                "edit_payout_period": true,
 +
                "edit_payvia": true,
 +
                "edit_payvia_field": true,
 +
                "edit_payvia_field_mc_details": true,
 +
                "edit_payvia_rule": true,
 +
                "edit_payvia_setup": true,
 +
                "dumps": true,
 +
                "payout_periods": true,
 +
                "payout_periods_set_affiliates": true,
 +
                "payvia_rules": true,
 +
                "auto": true,
 +
                "view_dump": true,
 +
                "view_payment_dump": true,
 +
                "payvia": true
 +
            },
 +
            "some_actions": true,
 +
            "action": {
 +
                "add_dump": true,
 +
                "add_payvia_field_mc": true,
 +
                "add_payout_period": true,
 +
                "add_payvia": true,
 +
                "add_payvia_field": true,
 +
                "add_payvia_rule": true,
 +
                "bulk_changes": true,
 +
                "copy_dump": true,
 +
                "delete_payout_period": true,
 +
                "payvia_field_mc_disable": true,
 +
                "disable_payvia": true,
 +
                "payvia_field_disable": true,
 +
                "disable_payvia_rule": true,
 +
                "edit_dump": true,
 +
                "edit_payvia_field_mc": true,
 +
                "edit_payment": true,
 +
                "edit_payout_period": true,
 +
                "edit_payvia": true,
 +
                "edit_payvia_field": true,
 +
                "edit_payvia_rule": true,
 +
                "payvia_field_mc_enable": true,
 +
                "enable_payvia": true,
 +
                "payvia_field_enable": true,
 +
                "mark_as_paid": true,
 +
                "payvia_field_mc_move_down": true,
 +
                "payvia_field_move_down": true,
 +
                "payvia_field_mc_move_up": true,
 +
                "payvia_field_move_up": true,
 +
                "payout_period_default": true,
 +
                "payout_periods_set_affiliates": true,
 +
                "restore_payout_period": true,
 +
                "store_open_payments": true,
 +
                "store_open_payment": true,
 +
                "unstore_stored_payment": true,
 +
                "unstore_payments": true
 +
            }
 +
        },
 +
        "programs": {
 +
            "display": true,
 +
            "all_views": true,
 +
            "all_actions": true,
 +
            "editable": true,
 +
            "some_views": true,
 +
            "view": {
 +
                "add": true,
 +
                "edit": true,
 +
                "set_affiliates": true,
 +
                "list_disabled": true,
 +
                "list_enabled": true
 +
            },
 +
            "some_actions": true,
 +
            "action": {
 +
                "add_tour_all": true,
 +
                "add": true,
 +
                "add_tour": true,
 +
                "change_disabled": true,
 +
                "change_enabled": true,
 +
                "delete": true,
 +
                "disable": true,
 +
                "edit_payout": true,
 +
                "edit": true,
 +
                "enable": true,
 +
                "remove_tour_all": true,
 +
                "remove_tour": true
 +
            }
 +
        },
 +
        "promotionals": {
 +
            "display": true,
 +
            "all_views": true,
 +
            "all_actions": true,
 +
            "editable": true,
 +
            "some_views": true,
 +
            "view": {
 +
                "edit_promotional": true,
 +
                "promotional_link": true,
 +
                "promotional_rules": true
 +
            },
 +
            "some_actions": true,
 +
            "action": {
 +
                "add_promotional": true,
 +
                "add_rule": true,
 +
                "delete_promotional": true,
 +
                "disable_rule": true,
 +
                "edit_promotional": true,
 +
                "edit_rule": true,
 +
                "restore_promotional": true
 +
            }
 +
        },
 +
        "reporting": {
 +
            "display": true,
 +
            "all_views": true,
 +
            "all_actions": true,
 +
            "editable": true,
 +
            "some_views": true,
 +
            "view": {
 +
                "acct_rep": true,
 +
                "actual_affiliate_payments": true,
 +
                "misc": true,
 +
                "affiliate_ratios": true,
 +
                "wm_join": true,
 +
                "referral": true,
 +
                "cascade": true,
 +
                "detail_trial": true,
 +
                "fraud": true,
 +
                "graphical_affiliate_comparison": true,
 +
                "payments_withheld": true,
 +
                "pending_transaction": true,
 +
                "profit_loss": true,
 +
                "related_transaction": true,
 +
                "retention": true,
 +
                "single_day_comparison": true,
 +
                "subscription": true,
 +
                "surfer": true,
 +
                "transaction": true
 +
            },
 +
            "some_actions": true,
 +
            "action": {
 +
                "edit_focus": true,
 +
                "edit_report": true
 +
            }
 +
        },
 +
        "rewards": {
 +
            "display": true,
 +
            "all_views": true,
 +
            "all_actions": true,
 +
            "editable": true,
 +
            "some_views": true,
 +
            "view": {
 +
                "points": true,
 +
                "shipped": true,
 +
                "unshipped": true
 +
            },
 +
            "some_actions": true,
 +
            "action": {
 +
                "add_cat": true,
 +
                "add_point_change": true,
 +
                "add": true,
 +
                "delete_cat": true,
 +
                "delete": true,
 +
                "delete_change": true,
 +
                "edit_points": true,
 +
                "edit": true,
 +
                "move": true,
 +
                "refund": true,
 +
                "ship": true,
 +
                "undelete_cat": true,
 +
                "undelete": true,
 +
                "unship": true
 +
            }
 +
        },
 +
        "sites_templates": {
 +
            "display": true,
 +
            "all_views": true,
 +
            "all_actions": true,
 +
            "editable": true,
 +
            "some_views": true,
 +
            "view": {
 +
                "edit": true,
 +
                "preview": true
 +
            },
 +
            "some_actions": true,
 +
            "action": {
 +
                "copy": true,
 +
                "customize_edit": true,
 +
                "revert": true,
 +
                "save": true
 +
            }
 +
        },
 +
        "sites": {
 +
            "display": true,
 +
            "all_views": true,
 +
            "all_actions": true,
 +
            "editable": true,
 +
            "some_views": true,
 +
            "view": {
 +
                "add": true,
 +
                "add_group": true,
 +
                "coupon_revisions": true,
 +
                "edit_coupon": true,
 +
                "edit": true,
 +
                "edit_group": true,
 +
                "edit_tour": true,
 +
                "options": true,
 +
                "partners": true,
 +
                "programs": true,
 +
                "redirects": true,
 +
                "special_options": true,
 +
                "css_colors": true,
 +
                "coupons": true,
 +
                "groups": true
 +
            },
 +
            "some_actions": true,
 +
            "action": {
 +
                "add_color": true,
 +
                "add_coupon": true,
 +
                "add_group": true,
 +
                "add_option": true,
 +
                "add_option_rule": true,
 +
                "add_redirect": true,
 +
                "add_redirect_rule": true,
 +
                "add": true,
 +
                "add_partner": true,
 +
                "add_tour": true,
 +
                "delete_group": true,
 +
                "delete_option": true,
 +
                "delete_redirect": true,
 +
                "delete": true,
 +
                "delete_partner": true,
 +
                "delete_tour": true,
 +
                "disable_option_rule": true,
 +
                "disable_redirect_rule": true,
 +
                "edit_coupon": true,
 +
                "edit_programs": true,
 +
                "edit_group": true,
 +
                "edit_option": true,
 +
                "edit_option_rule": true,
 +
                "edit_redirect": true,
 +
                "edit_redirect_rule": true,
 +
                "edit": true,
 +
                "edit_partner": true,
 +
                "edit_tour": true,
 +
                "edit_tour_options": true,
 +
                "move": true,
 +
                "undelete_group": true,
 +
                "revert_field": true,
 +
                "revert_tour_option": true,
 +
                "set_colors": true,
 +
                "undelete_option": true,
 +
                "undelete_redirect": true,
 +
                "undelete": true,
 +
                "undelete_partner": true,
 +
                "undelete_tour": true
 +
            }
 +
        },
 +
        "skins_templates": {
 +
            "display": true,
 +
            "all_views": true,
 +
            "all_actions": true,
 +
            "editable": true,
 +
            "some_views": true,
 +
            "view": {
 +
                "css_colors": true,
 +
                "edit": true,
 +
                "templates": true,
 +
                "export": true,
 +
                "import": true,
 +
                "preview_recovery": true,
 +
                "preview": true,
 +
                "read": true,
 +
                "special_templates": true,
 +
                "themes": true
 +
            },
 +
            "some_actions": true,
 +
            "action": {
 +
                "add_color": true,
 +
                "add_skin": true,
 +
                "add": true,
 +
                "copy": true,
 +
                "create_palette": true,
 +
                "customize": true,
 +
                "del_skin": true,
 +
                "edit_skin": true,
 +
                "export_run": true,
 +
                "flush": true,
 +
                "import_add": true,
 +
                "recover": true,
 +
                "revert": true,
 +
                "save_defaults": true,
 +
                "save": true,
 +
                "set_colors": true,
 +
                "set_palette": true
 +
            }
 +
        },
 +
        "support": {
 +
            "display": true,
 +
            "all_views": true,
 +
            "all_actions": true,
 +
            "editable": true,
 +
            "some_views": true,
 +
            "view": {
 +
                "admin_areas": true,
 +
                "change_log": true
 +
            },
 +
            "some_actions": true,
 +
            "action": {
 +
                "delete_link": true,
 +
                "edit_link": true,
 +
                "new_link": true
 +
            }
 +
        },
 +
        "third_party": {
 +
            "display": true,
 +
            "all_views": true,
 +
            "all_actions": true,
 +
            "editable": true,
 +
            "some_views": true,
 +
            "view": {
 +
                "biller_charges": true,
 +
                "poll_status": true
 +
            },
 +
            "some_actions": true,
 +
            "action": {
 +
                "add_biller": true,
 +
                "delete_biller": true,
 +
                "delete_biller_charge": true,
 +
                "edit_biller": true,
 +
                "set_biller_charge": true,
 +
                "restore_biller": true
 +
            }
 +
        },
 +
        "upsells": {
 +
            "display": true,
 +
            "all_views": true,
 +
            "all_actions": true,
 +
            "editable": true,
 +
            "some_views": true,
 +
            "view": {
 +
                "incoming_xsells": true,
 +
                "incoming_upsells": true,
 +
                "outgoing_xsells": true,
 +
                "outgoing_upsells": true
 +
            },
 +
            "some_actions": true,
 +
            "action": {
 +
                "add_rule": true,
 +
                "add": true,
 +
                "delete": true,
 +
                "disable_rule": true,
 +
                "edit_rule": true,
 +
                "edit": true,
 +
                "move": true,
 +
                "undelete": true
 +
            }
 +
        },
 +
        "ajax": {
 +
            "all_actions": true
 +
        }
 +
    }
 +
}
 +
</pre>
 +
 +
 +
  
 
== '''Example Code''' ==
 
== '''Example Code''' ==
Line 33: Line 840:
 
$url = 'http://yourdomain.com'; //set your NATS URL here
 
$url = 'http://yourdomain.com'; //set your NATS URL here
  
$data = array(
+
$data = array();
// Add API parameters here
 
);
 
  
 
$request = Array(
 
$request = Array(
Line 76: Line 881:
 
</pre>
 
</pre>
  
[[Category:NATS4_REST_APIs]]
+
[[Category:NATS5_REST_APIs]]
[[Category:NATS4_REST_affiliate_Collection]]
+
[[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/current-permissions

Description

  • Get the permissions for your user account

Resource URL

  • http://domain/api/affiliate/current-permissions
  • Replace domain with the nats domain

Request Method

  • GET

Response Format

  • JSON

Authentication

  • HTTP headers

Parameters

None

Example Request

Method: GET
URL: http://domain/api/affiliate/current-permissions

Response:

{
    "success": true,
    "permissions": {
        "overview": {
            "display": true,
            "all_views": true,
            "all_actions": true,
            "editable": true,
            "some_views": true,
            "view": {
                "default": true,
                "mobile_affiliates": true,
                "mobile_all": true,
                "mobile_new_affiliates": true,
                "mobile_new_members": true,
                "mobile_programs": true,
                "mobile_sites": true,
                "mobile_summary": true,
                "original": true
            }
        },
        "adtools": {
            "display": true,
            "all_views": true,
            "all_actions": true,
            "editable": true,
            "some_views": true,
            "view": {
                "bulk": true,
                "bulk_update": true,
                "adtools": true,
                "edit": true,
                "edit_rule": true,
                "edit_type": true,
                "group": true,
                "search": true,
                "set_cotd_content": true,
                "set_gbcontent": true,
                "set_gbtemplates": true,
                "stop_bulk": true
            },
            "some_actions": true,
            "action": {
                "add_cotd_content": true,
                "add_category": true,
                "add_assoc": true,
                "add_type_field_mc_option": true,
                "add_new_group": true,
                "add_rule": true,
                "add_type": true,
                "add_type_field": true,
                "bulk_import": true,
                "bulk_update": true,
                "move": true,
                "delete_cotd_content": true,
                "delete_category": true,
                "delete_group": true,
                "delete_mc_option": true,
                "delete_type": true,
                "delete_type_field": true,
                "disable_adtool": true,
                "disable_cotd_content": true,
                "disable_rule": true,
                "edit_adtool": true,
                "edit_category": true,
                "edit_group": true,
                "edit_mc_option": true,
                "edit_rule": true,
                "edit_type": true,
                "edit_type_field": true,
                "enable_adtool": true,
                "enable_cotd_content": true,
                "new_adtool": true,
                "remove_assoc": true,
                "set_cotd_current_content": true,
                "set_gbmatches": true,
                "sort": true,
                "undelete_category": true,
                "undelete_mc_option": true,
                "undelete_type": true,
                "undelete_type_field": true
            }
        },
        "affiliates": {
            "display": true,
            "all_views": true,
            "all_actions": true,
            "editable": true,
            "some_views": true,
            "view": {
                "add_sale": true,
                "account_access": true,
                "account_changes": true,
                "affiliate_documents": true,
                "affiliate_overview": true,
                "affiliate_payout_period": true,
                "affiliate_twofactor": true,
                "loginlog": true,
                "affiliate_approve": true,
                "change_pass": true,
                "affiliate_edit": true,
                "manual_invoices": true,
                "affiliate_status": true,
                "email_csv_dump": true
            },
            "some_actions": true,
            "action": {
                "document_add": true,
                "invoice_add": true,
                "add_sale": true,
                "note_new": true,
                "add_affiliate": true,
                "access_custom": true,
                "affiliate_twofactor": true,
                "account_changes": true,
                "approve_deny": true,
                "access_save": true,
                "affiliate_change_api_key": true,
                "change_pass": true,
                "affiliate_delete": true,
                "document_delete": true,
                "invoice_delete": true,
                "document_get": true,
                "edit_save": true,
                "invoice_edit": true,
                "payout_period_enable": true,
                "affiliate_clear_rep": true,
                "affiliate_clear_referrer": true,
                "affiliate_restore": true,
                "affiliate_assign_rep": true,
                "set_payout_period": true,
                "update_status": true,
                "affiliate_assign_ref": true
            }
        },
        "billers": {
            "display": true,
            "all_views": true,
            "all_actions": true,
            "editable": true,
            "some_views": true,
            "view": {
                "add_cascade": true,
                "biller_charges": true,
                "tax": true,
                "cascade_rules": true,
                "poll_status": true
            },
            "some_actions": true,
            "action": {
                "add_biller": true,
                "add_cascade": true,
                "add_cascade_rule": true,
                "set_tax": true,
                "delete_biller": true,
                "delete_biller_charge": true,
                "delete_cascade": true,
                "delete_cascade_step": true,
                "delete_tax": true,
                "disable_cascade_rule": true,
                "edit_biller": true,
                "edit_cascade": true,
                "edit_cascade_rule": true,
                "edit_cascade_step": true,
                "down_cascade_step": true,
                "up_cascade_step": true,
                "new_cascade_step": true,
                "set_biller_charge": true,
                "restore_biller": true,
                "restore_cascade": true
            }
        },
        "commissions": {
            "display": true,
            "all_views": true,
            "all_actions": true,
            "editable": true,
            "some_views": true,
            "view": {
                "add": true,
                "edit_change": true,
                "changes": true
            },
            "some_actions": true,
            "action": {
                "add": true,
                "add_tier": true,
                "delete_change": true,
                "delete_tier": true,
                "edit": true,
                "move": true,
                "save_change": true,
                "save_tier": true
            }
        },
        "config": {
            "display": true,
            "all_views": true,
            "all_actions": true,
            "editable": true,
            "some_views": true,
            "view": {
                "affiliate_default_settings": true,
                "affiliates": true,
                "currency - all": true,
                "billers": true,
                "cronjobs": true,
                "display": true,
                "emails": true,
                "external programs": true,
                "fraud": true,
                "logging": true,
                "home": true,
                "misc": true,
                "notifications": true,
                "postback": true,
                "security": true,
                "surfer": true,
                "third party": true,
                "currency - used": true
            },
            "some_actions": true,
            "action": {
                "revert": true,
                "save": true,
                "update_affiliates": true
            }
        },
        "global": {
            "editable": true,
            "some_actions": true,
            "action": {
                "edit_affiliate": true,
                "restrict_member_view": false
            },
            "setting": {
                "affiliate_override": {
                    "disabled": false,
                    "all_affiliates": true,
                    "my_affiliates": false,
                    "my_network": false
                }
            }
        },
        "includes": {
            "display": true,
            "all_views": true,
            "all_actions": true,
            "editable": true,
            "some_views": true,
            "view": {
                "edit_chain": true,
                "edit_rule": true,
                "edit_step": true,
                "rules": true,
                "steps": true
            },
            "some_actions": true,
            "action": {
                "add": true,
                "add_rule": true,
                "add_step": true,
                "delete": true,
                "delete_rule": true,
                "delete_step": true,
                "edit": true,
                "edit_rule": true,
                "edit_step": true,
                "undelete": true,
                "undelete_step": true
            }
        },
        "codes": {
            "display": true,
            "all_views": true,
            "all_actions": true,
            "editable": true,
            "some_views": true,
            "view": {
                "links": true,
                "strack": true
            },
            "some_actions": false
        },
        "logging": {
            "display": true,
            "all_views": true,
            "all_actions": true,
            "editable": true,
            "some_views": true,
            "view": {
                "admin_actions": true,
                "view_log": true
            },
            "some_actions": true,
            "action": {
                "search_log": true
            }
        },
        "mails": {
            "display": true,
            "all_views": true,
            "all_actions": true,
            "editable": true,
            "some_views": true,
            "view": {
                "queue": true,
                "remove": true,
                "mail": true
            },
            "some_actions": true,
            "action": {
                "add": true,
                "add_rule": true,
                "delete": true,
                "delete_queue_mail": true,
                "disable_rule": true,
                "edit": true,
                "edit_rule": true,
                "removelist_save": true,
                "reset": true,
                "undelete_queue_mail": true,
                "retry_queue_mail": true,
                "send": true,
                "send_test": true
            }
        },
        "cleanup": {
            "display": true,
            "all_views": true,
            "all_actions": true,
            "editable": true,
            "some_views": true,
            "view": {
                "clean_log": true,
                "clean_table": true,
                "cron": true,
                "errors": true,
                "fix_error": true,
                "logs": true,
                "status": true,
                "reports": true,
                "build_report": true,
                "view_table": true
            },
            "some_actions": true,
            "action": {
                "build_report": true,
                "clean_log": true,
                "remove_log": true,
                "clean_table": true,
                "clear_cache": true,
                "remove_error": true,
                "resolve_error": true
            }
        },
        "members": {
            "display": true,
            "all_views": true,
            "all_actions": true,
            "editable": true,
            "some_views": true,
            "view": {
                "add": true,
                "edit": true,
                "member": true,
                "email_csv_dump": true,
                "full_csv_dump": true
            },
            "some_actions": true,
            "action": {
                "add": true,
                "new_note": true,
                "delete": true,
                "delete_note": true,
                "edit": true,
                "lock_member": true,
                "mark": true,
                "unlock_member": true
            }
        },
        "network": {
            "display": true,
            "all_views": true,
            "all_actions": true,
            "editable": true,
            "some_views": false,
            "some_actions": true,
            "action": {
                "add_network": true,
                "save_changes": true
            }
        },
        "news": {
            "display": true,
            "all_views": true,
            "all_actions": true,
            "editable": true,
            "some_views": true,
            "view": {
                "new_news": true,
                "edit": true,
                "notifications": true,
                "reply_message": true,
                "send_message": true,
                "send_note": true,
                "messages": true,
                "view": true,
                "view_note": true
            },
            "some_actions": true,
            "action": {
                "add": true,
                "add_section": true,
                "delete_all": true,
                "delete": true,
                "delete_note": true,
                "del_section": true,
                "edit": true,
                "mark_all_read": true,
                "mark_all_unread": true,
                "unviewed": true,
                "viewed": true,
                "reply_message": true,
                "undelete_all": true,
                "send_message": true,
                "send_note": true,
                "undelete_note": true
            }
        },
        "payments": {
            "display": true,
            "all_views": true,
            "all_actions": true,
            "editable": true,
            "some_views": true,
            "view": {
                "edit_dump": true,
                "edit_payvia_field_mc": true,
                "edit_open_payments": true,
                "edit_payout_period": true,
                "edit_payvia": true,
                "edit_payvia_field": true,
                "edit_payvia_field_mc_details": true,
                "edit_payvia_rule": true,
                "edit_payvia_setup": true,
                "dumps": true,
                "payout_periods": true,
                "payout_periods_set_affiliates": true,
                "payvia_rules": true,
                "auto": true,
                "view_dump": true,
                "view_payment_dump": true,
                "payvia": true
            },
            "some_actions": true,
            "action": {
                "add_dump": true,
                "add_payvia_field_mc": true,
                "add_payout_period": true,
                "add_payvia": true,
                "add_payvia_field": true,
                "add_payvia_rule": true,
                "bulk_changes": true,
                "copy_dump": true,
                "delete_payout_period": true,
                "payvia_field_mc_disable": true,
                "disable_payvia": true,
                "payvia_field_disable": true,
                "disable_payvia_rule": true,
                "edit_dump": true,
                "edit_payvia_field_mc": true,
                "edit_payment": true,
                "edit_payout_period": true,
                "edit_payvia": true,
                "edit_payvia_field": true,
                "edit_payvia_rule": true,
                "payvia_field_mc_enable": true,
                "enable_payvia": true,
                "payvia_field_enable": true,
                "mark_as_paid": true,
                "payvia_field_mc_move_down": true,
                "payvia_field_move_down": true,
                "payvia_field_mc_move_up": true,
                "payvia_field_move_up": true,
                "payout_period_default": true,
                "payout_periods_set_affiliates": true,
                "restore_payout_period": true,
                "store_open_payments": true,
                "store_open_payment": true,
                "unstore_stored_payment": true,
                "unstore_payments": true
            }
        },
        "programs": {
            "display": true,
            "all_views": true,
            "all_actions": true,
            "editable": true,
            "some_views": true,
            "view": {
                "add": true,
                "edit": true,
                "set_affiliates": true,
                "list_disabled": true,
                "list_enabled": true
            },
            "some_actions": true,
            "action": {
                "add_tour_all": true,
                "add": true,
                "add_tour": true,
                "change_disabled": true,
                "change_enabled": true,
                "delete": true,
                "disable": true,
                "edit_payout": true,
                "edit": true,
                "enable": true,
                "remove_tour_all": true,
                "remove_tour": true
            }
        },
        "promotionals": {
            "display": true,
            "all_views": true,
            "all_actions": true,
            "editable": true,
            "some_views": true,
            "view": {
                "edit_promotional": true,
                "promotional_link": true,
                "promotional_rules": true
            },
            "some_actions": true,
            "action": {
                "add_promotional": true,
                "add_rule": true,
                "delete_promotional": true,
                "disable_rule": true,
                "edit_promotional": true,
                "edit_rule": true,
                "restore_promotional": true
            }
        },
        "reporting": {
            "display": true,
            "all_views": true,
            "all_actions": true,
            "editable": true,
            "some_views": true,
            "view": {
                "acct_rep": true,
                "actual_affiliate_payments": true,
                "misc": true,
                "affiliate_ratios": true,
                "wm_join": true,
                "referral": true,
                "cascade": true,
                "detail_trial": true,
                "fraud": true,
                "graphical_affiliate_comparison": true,
                "payments_withheld": true,
                "pending_transaction": true,
                "profit_loss": true,
                "related_transaction": true,
                "retention": true,
                "single_day_comparison": true,
                "subscription": true,
                "surfer": true,
                "transaction": true
            },
            "some_actions": true,
            "action": {
                "edit_focus": true,
                "edit_report": true
            }
        },
        "rewards": {
            "display": true,
            "all_views": true,
            "all_actions": true,
            "editable": true,
            "some_views": true,
            "view": {
                "points": true,
                "shipped": true,
                "unshipped": true
            },
            "some_actions": true,
            "action": {
                "add_cat": true,
                "add_point_change": true,
                "add": true,
                "delete_cat": true,
                "delete": true,
                "delete_change": true,
                "edit_points": true,
                "edit": true,
                "move": true,
                "refund": true,
                "ship": true,
                "undelete_cat": true,
                "undelete": true,
                "unship": true
            }
        },
        "sites_templates": {
            "display": true,
            "all_views": true,
            "all_actions": true,
            "editable": true,
            "some_views": true,
            "view": {
                "edit": true,
                "preview": true
            },
            "some_actions": true,
            "action": {
                "copy": true,
                "customize_edit": true,
                "revert": true,
                "save": true
            }
        },
        "sites": {
            "display": true,
            "all_views": true,
            "all_actions": true,
            "editable": true,
            "some_views": true,
            "view": {
                "add": true,
                "add_group": true,
                "coupon_revisions": true,
                "edit_coupon": true,
                "edit": true,
                "edit_group": true,
                "edit_tour": true,
                "options": true,
                "partners": true,
                "programs": true,
                "redirects": true,
                "special_options": true,
                "css_colors": true,
                "coupons": true,
                "groups": true
            },
            "some_actions": true,
            "action": {
                "add_color": true,
                "add_coupon": true,
                "add_group": true,
                "add_option": true,
                "add_option_rule": true,
                "add_redirect": true,
                "add_redirect_rule": true,
                "add": true,
                "add_partner": true,
                "add_tour": true,
                "delete_group": true,
                "delete_option": true,
                "delete_redirect": true,
                "delete": true,
                "delete_partner": true,
                "delete_tour": true,
                "disable_option_rule": true,
                "disable_redirect_rule": true,
                "edit_coupon": true,
                "edit_programs": true,
                "edit_group": true,
                "edit_option": true,
                "edit_option_rule": true,
                "edit_redirect": true,
                "edit_redirect_rule": true,
                "edit": true,
                "edit_partner": true,
                "edit_tour": true,
                "edit_tour_options": true,
                "move": true,
                "undelete_group": true,
                "revert_field": true,
                "revert_tour_option": true,
                "set_colors": true,
                "undelete_option": true,
                "undelete_redirect": true,
                "undelete": true,
                "undelete_partner": true,
                "undelete_tour": true
            }
        },
        "skins_templates": {
            "display": true,
            "all_views": true,
            "all_actions": true,
            "editable": true,
            "some_views": true,
            "view": {
                "css_colors": true,
                "edit": true,
                "templates": true,
                "export": true,
                "import": true,
                "preview_recovery": true,
                "preview": true,
                "read": true,
                "special_templates": true,
                "themes": true
            },
            "some_actions": true,
            "action": {
                "add_color": true,
                "add_skin": true,
                "add": true,
                "copy": true,
                "create_palette": true,
                "customize": true,
                "del_skin": true,
                "edit_skin": true,
                "export_run": true,
                "flush": true,
                "import_add": true,
                "recover": true,
                "revert": true,
                "save_defaults": true,
                "save": true,
                "set_colors": true,
                "set_palette": true
            }
        },
        "support": {
            "display": true,
            "all_views": true,
            "all_actions": true,
            "editable": true,
            "some_views": true,
            "view": {
                "admin_areas": true,
                "change_log": true
            },
            "some_actions": true,
            "action": {
                "delete_link": true,
                "edit_link": true,
                "new_link": true
            }
        },
        "third_party": {
            "display": true,
            "all_views": true,
            "all_actions": true,
            "editable": true,
            "some_views": true,
            "view": {
                "biller_charges": true,
                "poll_status": true
            },
            "some_actions": true,
            "action": {
                "add_biller": true,
                "delete_biller": true,
                "delete_biller_charge": true,
                "edit_biller": true,
                "set_biller_charge": true,
                "restore_biller": true
            }
        },
        "upsells": {
            "display": true,
            "all_views": true,
            "all_actions": true,
            "editable": true,
            "some_views": true,
            "view": {
                "incoming_xsells": true,
                "incoming_upsells": true,
                "outgoing_xsells": true,
                "outgoing_upsells": true
            },
            "some_actions": true,
            "action": {
                "add_rule": true,
                "add": true,
                "delete": true,
                "disable_rule": true,
                "edit_rule": true,
                "edit": true,
                "move": true,
                "undelete": true
            }
        },
        "ajax": {
            "all_actions": 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();

$request = Array(
	'method' => 'GET',
	'path' => 'v1/affiliate/current-permissions',
	'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);
?>