Difference between revisions of "NATS5 REST API Affiliate GET rest-methods"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Affiliate GET rest-methods to NATS5 REST API Affiliate GET rest-methods: Renaming NATS5 API pages) |
|
(No difference)
| |
Revision as of 15:16, 9 August 2019
GET /affiliate/rest-methods
Description
- Get available Rest API Methods
Resource URL
- http://domain/api/affiliate/rest-methods
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- collection
- type: string
- optional
- limited
- optional
- loginid
- optional
Example Request
Method: GET
URL: http://domain/api/affiliate/rest-methods
Response:
{
"success": true,
"permissions": {
"all": {
"collection": -1,
"method": -1,
"resource": -1,
"description": "Entire REST API",
"sensitive_apis": [
{
"collection": "affiliate",
"method": "PATCH",
"resource": "account-type-permissions",
"description": "Update account type permissions",
"key": "affiliate-PATCH-account-type-permissions"
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "affiliate-account-type",
"description": "Update the account type for a list of affiliates",
"key": "affiliate-PATCH-affiliate-account-type"
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "password",
"description": "Update affiliate password",
"key": "affiliate-PATCH-password"
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "permissions",
"description": "Update affiliate permissions",
"key": "affiliate-PATCH-permissions"
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "reset-api",
"description": "Reset affiliate API key",
"key": "affiliate-PATCH-reset-api"
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "rest-permissions",
"description": "Update REST API permissions",
"key": "affiliate-PATCH-rest-permissions"
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "soap-permissions",
"description": "Update SOAP API permissions",
"key": "affiliate-PATCH-soap-permissions"
},
{
"collection": "config",
"method": "DELETE",
"resource": "setting",
"description": "Revert a config setting to the default",
"key": "config-DELETE-setting"
},
{
"collection": "config",
"method": "PATCH",
"resource": "section",
"description": "Update a config section",
"key": "config-PATCH-section"
},
{
"collection": "maintenance",
"method": "GET",
"resource": "admin-actions",
"description": "Search admin actions",
"key": "maintenance-GET-admin-actions"
},
{
"collection": "maintenance",
"method": "GET",
"resource": "log",
"description": "Get lines from log file",
"key": "maintenance-GET-log"
},
{
"collection": "maintenance",
"method": "PATCH",
"resource": "log",
"description": "Cleanup log file",
"key": "maintenance-PATCH-log"
},
{
"collection": "site",
"method": "POST",
"resource": "copy-template",
"description": "Copy template",
"key": "site-POST-copy-template"
},
{
"collection": "site",
"method": "PATCH",
"resource": "template",
"description": "Edit template",
"key": "site-PATCH-template"
},
{
"collection": "site",
"method": "DELETE",
"resource": "template",
"description": "Revert template",
"key": "site-DELETE-template"
},
{
"collection": "skin",
"method": "DELETE",
"resource": "skin",
"description": "Delete skin",
"key": "skin-DELETE-skin"
},
{
"collection": "skin",
"method": "DELETE",
"resource": "template",
"description": "Revert template",
"key": "skin-DELETE-template"
},
{
"collection": "skin",
"method": "PATCH",
"resource": "skin",
"description": "Edit skin",
"key": "skin-PATCH-skin"
},
{
"collection": "skin",
"method": "PATCH",
"resource": "template",
"description": "Edit template",
"key": "skin-PATCH-template"
},
{
"collection": "skin",
"method": "POST",
"resource": "import",
"description": "Import backed up skin",
"key": "skin-POST-import"
},
{
"collection": "skin",
"method": "POST",
"resource": "skin",
"description": "Add new skin",
"key": "skin-POST-skin"
},
{
"collection": "skin",
"method": "POST",
"resource": "template",
"description": "Add new template",
"key": "skin-POST-template"
}
]
},
"collections": [
{
"name": "adtool",
"all": {
"collection": "adtool",
"method": -1,
"resource": -1,
"description": "Entire adtool REST API collection",
"sensitive_apis": []
},
"methods": {
"GET": {
"name": "GET",
"all": {
"collection": "adtool",
"method": "GET",
"resource": -1,
"description": "All GET resources in the adtool REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "adtool",
"method": "GET",
"resource": "admin",
"description": "Search for adtools of a specific type",
"sensitive": 0
},
{
"collection": "adtool",
"method": "GET",
"resource": "adtools",
"description": "Get list of adtools",
"sensitive": 0
},
{
"collection": "adtool",
"method": "GET",
"resource": "adtool",
"description": "Get adtool details",
"sensitive": 0
},
{
"collection": "adtool",
"method": "GET",
"resource": "adtool-rules",
"description": null,
"sensitive": 0
},
{
"collection": "adtool",
"method": "GET",
"resource": "adtool-rule",
"description": null,
"sensitive": 0
},
{
"collection": "adtool",
"method": "GET",
"resource": "categories",
"description": "Get categories of adtools",
"sensitive": 0
},
{
"collection": "adtool",
"method": "GET",
"resource": "field-options",
"description": "Get multiple choice options for adtool field",
"sensitive": 0
},
{
"collection": "adtool",
"method": "GET",
"resource": "field-types",
"description": "Get available field types for adtool fields",
"sensitive": 0
},
{
"collection": "adtool",
"method": "GET",
"resource": "groups",
"description": "Get groups of adtools",
"sensitive": 0
},
{
"collection": "adtool",
"method": "GET",
"resource": "search",
"description": "Search for adtools of a specific type",
"sensitive": 0
},
{
"collection": "adtool",
"method": "GET",
"resource": "templates",
"description": "Get available templates for adtools",
"sensitive": 0
},
{
"collection": "adtool",
"method": "GET",
"resource": "types",
"description": "Get types of adtools",
"sensitive": 0
},
{
"collection": "adtool",
"method": "GET",
"resource": "type",
"description": "Get details of adtool type",
"sensitive": 0
}
]
},
"POST": {
"name": "POST",
"all": {
"collection": "adtool",
"method": "POST",
"resource": -1,
"description": "All POST resources in the adtool REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "adtool",
"method": "POST",
"resource": "adtool",
"description": "Add adtool",
"sensitive": 0
},
{
"collection": "adtool",
"method": "POST",
"resource": "adtool-rule",
"description": "Add new adtool rule",
"sensitive": 0
},
{
"collection": "adtool",
"method": "POST",
"resource": "category",
"description": "Add new adtool type category",
"sensitive": 0
},
{
"collection": "adtool",
"method": "POST",
"resource": "field",
"description": "Add new adtool type field",
"sensitive": 0
},
{
"collection": "adtool",
"method": "POST",
"resource": "field-option",
"description": "Add new adtool field multiple choice option",
"sensitive": 0
},
{
"collection": "adtool",
"method": "POST",
"resource": "group",
"description": "Add new adtools group",
"sensitive": 0
},
{
"collection": "adtool",
"method": "POST",
"resource": "import",
"description": "Import adtools of a specific type",
"sensitive": 0
},
{
"collection": "adtool",
"method": "POST",
"resource": "type",
"description": "Add new adtool type",
"sensitive": 0
}
]
},
"PATCH": {
"name": "PATCH",
"all": {
"collection": "adtool",
"method": "PATCH",
"resource": -1,
"description": "All PATCH resources in the adtool REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "adtool",
"method": "PATCH",
"resource": "adtool",
"description": "Edit adtool details",
"sensitive": 0
},
{
"collection": "adtool",
"method": "PATCH",
"resource": "adtool-group",
"description": "update adtool group",
"sensitive": 0
},
{
"collection": "adtool",
"method": "PATCH",
"resource": "adtool-rule",
"description": "Edit adtool rule",
"sensitive": 0
},
{
"collection": "adtool",
"method": "PATCH",
"resource": "category",
"description": "Edit adtool type category",
"sensitive": 0
},
{
"collection": "adtool",
"method": "PATCH",
"resource": "field",
"description": "Edit adtool type field",
"sensitive": 0
},
{
"collection": "adtool",
"method": "PATCH",
"resource": "field-option",
"description": "Edit adtool field multiple choice option",
"sensitive": 0
},
{
"collection": "adtool",
"method": "PATCH",
"resource": "group",
"description": "update group",
"sensitive": 0
},
{
"collection": "adtool",
"method": "PATCH",
"resource": "move",
"description": "Move item to new location",
"sensitive": 0
},
{
"collection": "adtool",
"method": "PATCH",
"resource": "restore-adtool",
"description": "Delete adtool",
"sensitive": 0
},
{
"collection": "adtool",
"method": "PATCH",
"resource": "restore-category",
"description": "Restore deleted adtool type category",
"sensitive": 0
},
{
"collection": "adtool",
"method": "PATCH",
"resource": "restore-field",
"description": "Restore adtool field",
"sensitive": 0
},
{
"collection": "adtool",
"method": "PATCH",
"resource": "restore-field-option",
"description": "Restore adtool field multiple choice option",
"sensitive": 0
},
{
"collection": "adtool",
"method": "PATCH",
"resource": "restore-type",
"description": "Restore adtool type",
"sensitive": 0
},
{
"collection": "adtool",
"method": "PATCH",
"resource": "type",
"description": "Edit adtool type",
"sensitive": 0
}
]
},
"DELETE": {
"name": "DELETE",
"all": {
"collection": "adtool",
"method": "DELETE",
"resource": -1,
"description": "All DELETE resources in the adtool REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "adtool",
"method": "DELETE",
"resource": "adtool",
"description": "Delete adtool",
"sensitive": 0
},
{
"collection": "adtool",
"method": "DELETE",
"resource": "adtool-rule",
"description": "Disable adtool rule",
"sensitive": 0
},
{
"collection": "adtool",
"method": "DELETE",
"resource": "category",
"description": "Delete adtool type category",
"sensitive": 0
},
{
"collection": "adtool",
"method": "DELETE",
"resource": "field",
"description": "delete adtool field",
"sensitive": 0
},
{
"collection": "adtool",
"method": "DELETE",
"resource": "field-option",
"description": "Delete adtool field multiple choice option",
"sensitive": 0
},
{
"collection": "adtool",
"method": "DELETE",
"resource": "group",
"description": "delete adtool group",
"sensitive": 0
},
{
"collection": "adtool",
"method": "DELETE",
"resource": "type",
"description": "Delete adtool type",
"sensitive": 0
}
]
}
}
},
{
"name": "affiliate",
"all": {
"collection": "affiliate",
"method": -1,
"resource": -1,
"description": "Entire affiliate REST API collection",
"sensitive_apis": [
{
"collection": "affiliate",
"method": "PATCH",
"resource": "account-type-permissions",
"description": "Update account type permissions",
"key": "affiliate-PATCH-account-type-permissions"
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "affiliate-account-type",
"description": "Update the account type for a list of affiliates",
"key": "affiliate-PATCH-affiliate-account-type"
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "password",
"description": "Update affiliate password",
"key": "affiliate-PATCH-password"
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "permissions",
"description": "Update affiliate permissions",
"key": "affiliate-PATCH-permissions"
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "reset-api",
"description": "Reset affiliate API key",
"key": "affiliate-PATCH-reset-api"
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "rest-permissions",
"description": "Update REST API permissions",
"key": "affiliate-PATCH-rest-permissions"
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "soap-permissions",
"description": "Update SOAP API permissions",
"key": "affiliate-PATCH-soap-permissions"
}
]
},
"methods": {
"DELETE": {
"name": "DELETE",
"all": {
"collection": "affiliate",
"method": "DELETE",
"resource": -1,
"description": "All DELETE resources in the affiliate REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "affiliate",
"method": "DELETE",
"resource": "account-rep",
"description": "Remove account rep from affiliates",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "DELETE",
"resource": "account-type",
"description": "Delete account type",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "DELETE",
"resource": "affiliate",
"description": "Delete affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "DELETE",
"resource": "doc",
"description": "Delete affiliate document",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "DELETE",
"resource": "group",
"description": "Delete affiliate group",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "DELETE",
"resource": "override",
"description": "End overriding as an affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "DELETE",
"resource": "permissions",
"description": "Delete affiliate custom permissions",
"sensitive": 0
}
]
},
"GET": {
"name": "GET",
"all": {
"collection": "affiliate",
"method": "GET",
"resource": -1,
"description": "All GET resources in the affiliate REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "affiliate",
"method": "GET",
"resource": "account-changes",
"description": "Get affiliate account changes",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "account-types",
"description": "Get affiliate account types",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "admin-settings",
"description": "Get affiliate admin settings",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "campaigns",
"description": "Get campaigns for a specific affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "current",
"description": "Get data for current affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "current-permissions",
"description": "Get the permissions for your user account",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "docs",
"description": "Get list of uploaded documents for affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "doc",
"description": "Download document for affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "groups",
"description": "Get affiliate groups",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "group",
"description": "Get an affiliate group",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "hits",
"description": "Get hit data for a specific affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "link-styles",
"description": "Get the list of possible link styles for affiliate links",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "loginids",
"description": "Look up login id values for a list of usernames",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "loginlog",
"description": "Get the login log for a specific affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "manual-payout",
"description": "Calculate the manual payout amount for an affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "news-sections",
"description": "Get the list of available news sections",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "notes",
"description": "Got notes for a specific affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "notices",
"description": "Get pending notices for an affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "override",
"description": "Get data for affiliate currently overriding as",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "payout",
"description": "Get payments for a specific affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "payment-periods",
"description": "Get payment periods available for an affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "payvia-types",
"description": "Get payvia types available for an affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "payvia-type",
"description": "Get payvia type information for an affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "permissions",
"description": "Get permission details for an account type",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "programcampaigns",
"description": "Get programs and campaigns for a specific affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "referrer",
"description": "Get affiliate referral for an affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "referring-urls",
"description": "Get referring URLs for an affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "reps",
"description": "Get account reps for an affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "rest-methods",
"description": "Get available Rest API Methods",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "search",
"description": "Search affiliates",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "search-filters",
"description": "Get available filter information for affiliate search API",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "search-limited",
"description": "Search affiliates",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "settings",
"description": "Get settings for an affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "skins",
"description": "Get available skins for an affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "soap-functions",
"description": "Get available SOAP API functions and (optionally) current permissions",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "GET",
"resource": "status",
"description": "Get status for an affiliate",
"sensitive": 0
}
]
},
"PATCH": {
"name": "PATCH",
"all": {
"collection": "affiliate",
"method": "PATCH",
"resource": -1,
"description": "All PATCH resources in the affiliate REST API collection",
"sensitive_apis": [
{
"collection": "affiliate",
"method": "PATCH",
"resource": "account-type-permissions",
"description": "Update account type permissions",
"key": "affiliate-PATCH-account-type-permissions"
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "affiliate-account-type",
"description": "Update the account type for a list of affiliates",
"key": "affiliate-PATCH-affiliate-account-type"
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "password",
"description": "Update affiliate password",
"key": "affiliate-PATCH-password"
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "permissions",
"description": "Update affiliate permissions",
"key": "affiliate-PATCH-permissions"
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "reset-api",
"description": "Reset affiliate API key",
"key": "affiliate-PATCH-reset-api"
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "rest-permissions",
"description": "Update REST API permissions",
"key": "affiliate-PATCH-rest-permissions"
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "soap-permissions",
"description": "Update SOAP API permissions",
"key": "affiliate-PATCH-soap-permissions"
}
]
},
"resources": [
{
"collection": "affiliate",
"method": "PATCH",
"resource": "adminsettings",
"description": "Update admin settings for a specific affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "account-change",
"description": "Update pending account change",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "account-type",
"description": "Update account type name",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "account-type-permissions",
"description": "Update account type permissions",
"sensitive": 1,
"sensitive_apis": [
{
"collection": "affiliate",
"method": "PATCH",
"resource": "account-type-permissions",
"description": "Update account type permissions",
"key": "affiliate-PATCH-account-type-permissions"
}
]
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "admin-setting",
"description": "Update affiliate admin setting",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "affiliate-account-type",
"description": "Update the account type for a list of affiliates",
"sensitive": 1,
"sensitive_apis": [
{
"collection": "affiliate",
"method": "PATCH",
"resource": "affiliate-account-type",
"description": "Update the account type for a list of affiliates",
"key": "affiliate-PATCH-affiliate-account-type"
}
]
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "affiliate-group",
"description": "Enable or disable affiliate for group",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "allsettings",
"description": "Update all affiliate settings",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "account-rep",
"description": "Update the account rep for a list of affiliates",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "avatar",
"description": "Crop temp avatar and set as avatar for affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "customs",
"description": "Update custom fields for a specific affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "defaults",
"description": "Update default info for a specific affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "details",
"description": "Update details for a specific affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "override",
"description": "Start overriding as an affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "end-override",
"description": "End overriding as affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "password",
"description": "Update affiliate password",
"sensitive": 1,
"sensitive_apis": [
{
"collection": "affiliate",
"method": "PATCH",
"resource": "password",
"description": "Update affiliate password",
"key": "affiliate-PATCH-password"
}
]
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "payment-period",
"description": "Update affiliate payout period",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "payvia",
"description": "Update payvia info for a specific affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "payvia-info",
"description": "Update payvia info for a specific affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "permissions",
"description": "Update affiliate permissions",
"sensitive": 1,
"sensitive_apis": [
{
"collection": "affiliate",
"method": "PATCH",
"resource": "permissions",
"description": "Update affiliate permissions",
"key": "affiliate-PATCH-permissions"
}
]
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "referrer",
"description": "Set referrer for affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "reset-api",
"description": "Reset affiliate API key",
"sensitive": 1,
"sensitive_apis": [
{
"collection": "affiliate",
"method": "PATCH",
"resource": "reset-api",
"description": "Reset affiliate API key",
"key": "affiliate-PATCH-reset-api"
}
]
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "reset-rss",
"description": "Reset affiliate RSS key",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "reset-tos",
"description": "Reset affiliates Terms of Service",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "rest-permissions",
"description": "Update REST API permissions",
"sensitive": 1,
"sensitive_apis": [
{
"collection": "affiliate",
"method": "PATCH",
"resource": "rest-permissions",
"description": "Update REST API permissions",
"key": "affiliate-PATCH-rest-permissions"
}
]
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "restore",
"description": "Restore a deleted affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "restore-account-type",
"description": "Restore a deleted affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "settings",
"description": "Update settings for a specific affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "soap-permissions",
"description": "Update SOAP API permissions",
"sensitive": 1,
"sensitive_apis": [
{
"collection": "affiliate",
"method": "PATCH",
"resource": "soap-permissions",
"description": "Update SOAP API permissions",
"key": "affiliate-PATCH-soap-permissions"
}
]
},
{
"collection": "affiliate",
"method": "PATCH",
"resource": "status",
"description": "Update status for a specific affiliate",
"sensitive": 0
}
]
},
"POST": {
"name": "POST",
"all": {
"collection": "affiliate",
"method": "POST",
"resource": -1,
"description": "All POST resources in the affiliate REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "affiliate",
"method": "POST",
"resource": "account-type",
"description": "Add new affiliate account type",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "POST",
"resource": "add",
"description": "Add affiliates",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "POST",
"resource": "doc",
"description": "Add document for affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "POST",
"resource": "group",
"description": "Add affiliate group",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "POST",
"resource": "invoice",
"description": "Add a manual invoice for a specific affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "POST",
"resource": "manual-sale",
"description": "Add manual sale for affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "POST",
"resource": "note",
"description": "Add note for affiliate",
"sensitive": 0
},
{
"collection": "affiliate",
"method": "POST",
"resource": "temp-avatar",
"description": "Upload temporary avatar for affiliate for editing",
"sensitive": 0
}
]
}
}
},
{
"name": "biller",
"all": {
"collection": "biller",
"method": -1,
"resource": -1,
"description": "Entire biller REST API collection",
"sensitive_apis": []
},
"methods": {
"GET": {
"name": "GET",
"all": {
"collection": "biller",
"method": "GET",
"resource": -1,
"description": "All GET resources in the biller REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "biller",
"method": "GET",
"resource": "available",
"description": "Get available billers",
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "partner-available",
"description": "Get available partners",
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "billerdata",
"description": "Get biller specific information for a particular biller\/tour\/option",
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "cascades",
"description": "Get cascades",
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "cascades-available",
"description": "Get cascades",
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "cascade-count",
"description": "Get count of matching cascades",
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "cascade-history",
"description": "Get history of changes to cascade",
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "cascade-rules",
"description": null,
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "cascade-rule",
"description": null,
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "cascade-step-count",
"description": "Get count of cascade steps",
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "cascade-steps",
"description": "Get cascade steps",
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "cascade-detail",
"description": "Get details for a cascade",
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "cascade-list",
"description": "Get a cascade list",
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "count",
"description": "Get count of matching billers",
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "detail",
"description": "Get details for a biller",
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "fees",
"description": "Get fees for a biller",
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "partner-fees",
"description": "Get fees for a third party partner",
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "last_poll",
"description": "Get last poll for a biller",
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "partner-last-poll",
"description": "Get last poll for a third party partner",
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "list",
"description": "Get list of billers",
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "partner-detail",
"description": "Get details for a partner",
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "partner-list",
"description": "Get list of partners",
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "partner-shortnames",
"description": "Get list of partner shortnames",
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "process_types",
"description": "Get available process types for a biller",
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "partner-process-types",
"description": "Get available process types for a third party partner",
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "shortnames",
"description": "Get list of biller shortnames",
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "transaction_types",
"description": "Get available process types for a biller",
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "partner-transaction-types",
"description": "Get available process types for a third party partner",
"sensitive": 0
},
{
"collection": "biller",
"method": "GET",
"resource": "taxes",
"description": "Get taxes",
"sensitive": 0
}
]
},
"POST": {
"name": "POST",
"all": {
"collection": "biller",
"method": "POST",
"resource": -1,
"description": "All POST resources in the biller REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "biller",
"method": "POST",
"resource": "add",
"description": "Add new biller",
"sensitive": 0
},
{
"collection": "biller",
"method": "POST",
"resource": "cascade",
"description": "Add new biller",
"sensitive": 0
},
{
"collection": "biller",
"method": "POST",
"resource": "cascade-rule",
"description": "Add new cascade rule",
"sensitive": 0
},
{
"collection": "biller",
"method": "POST",
"resource": "cascade-step",
"description": "Add new cascade step",
"sensitive": 0
},
{
"collection": "biller",
"method": "POST",
"resource": "partner",
"description": "Add new third party partner",
"sensitive": 0
}
]
},
"PATCH": {
"name": "PATCH",
"all": {
"collection": "biller",
"method": "PATCH",
"resource": -1,
"description": "All PATCH resources in the biller REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "biller",
"method": "PATCH",
"resource": "cascade",
"description": "Edit cascade",
"sensitive": 0
},
{
"collection": "biller",
"method": "PATCH",
"resource": "cascade-rule",
"description": "Edit cascade rule",
"sensitive": 0
},
{
"collection": "biller",
"method": "PATCH",
"resource": "cascade-step",
"description": "Edit cascade step",
"sensitive": 0
},
{
"collection": "biller",
"method": "PATCH",
"resource": "cascade-steps-reorder",
"description": "Reorder steps in cascade",
"sensitive": 0
},
{
"collection": "biller",
"method": "PATCH",
"resource": "fee",
"description": "Setup fee for biller",
"sensitive": 0
},
{
"collection": "biller",
"method": "PATCH",
"resource": "partner-fee",
"description": "Setup fee for third party partner",
"sensitive": 0
},
{
"collection": "biller",
"method": "PATCH",
"resource": "restore",
"description": "Restore biller",
"sensitive": 0
},
{
"collection": "biller",
"method": "PATCH",
"resource": "restore-cascade",
"description": "Restore cascade",
"sensitive": 0
},
{
"collection": "biller",
"method": "PATCH",
"resource": "restore-partner",
"description": "Restore partner",
"sensitive": 0
},
{
"collection": "biller",
"method": "PATCH",
"resource": "setting",
"description": "Edit cascade",
"sensitive": 0
},
{
"collection": "biller",
"method": "PATCH",
"resource": "partner-setting",
"description": "Edit cascade",
"sensitive": 0
},
{
"collection": "biller",
"method": "PATCH",
"resource": "tax",
"description": "Update taxes",
"sensitive": 0
}
]
},
"DELETE": {
"name": "DELETE",
"all": {
"collection": "biller",
"method": "DELETE",
"resource": -1,
"description": "All DELETE resources in the biller REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "biller",
"method": "DELETE",
"resource": "biller",
"description": "Delete biller",
"sensitive": 0
},
{
"collection": "biller",
"method": "DELETE",
"resource": "cascade",
"description": "Delete cascade",
"sensitive": 0
},
{
"collection": "biller",
"method": "DELETE",
"resource": "cascade-rule",
"description": "Disable cascade rule",
"sensitive": 0
},
{
"collection": "biller",
"method": "DELETE",
"resource": "cascade-step",
"description": "Delete cascade step",
"sensitive": 0
},
{
"collection": "biller",
"method": "DELETE",
"resource": "fee",
"description": "Delete biller fee",
"sensitive": 0
},
{
"collection": "biller",
"method": "DELETE",
"resource": "partner-fee",
"description": "Delete biller fee",
"sensitive": 0
},
{
"collection": "biller",
"method": "DELETE",
"resource": "partner",
"description": "Delete partner",
"sensitive": 0
},
{
"collection": "biller",
"method": "DELETE",
"resource": "tax",
"description": "Delete tax",
"sensitive": 0
}
]
}
}
},
{
"name": "config",
"all": {
"collection": "config",
"method": -1,
"resource": -1,
"description": "Entire config REST API collection",
"sensitive_apis": [
{
"collection": "config",
"method": "DELETE",
"resource": "setting",
"description": "Revert a config setting to the default",
"key": "config-DELETE-setting"
},
{
"collection": "config",
"method": "PATCH",
"resource": "section",
"description": "Update a config section",
"key": "config-PATCH-section"
}
]
},
"methods": {
"DELETE": {
"name": "DELETE",
"all": {
"collection": "config",
"method": "DELETE",
"resource": -1,
"description": "All DELETE resources in the config REST API collection",
"sensitive_apis": [
{
"collection": "config",
"method": "DELETE",
"resource": "setting",
"description": "Revert a config setting to the default",
"key": "config-DELETE-setting"
}
]
},
"resources": [
{
"collection": "config",
"method": "DELETE",
"resource": "setting",
"description": "Revert a config setting to the default",
"sensitive": 1,
"sensitive_apis": [
{
"collection": "config",
"method": "DELETE",
"resource": "setting",
"description": "Revert a config setting to the default",
"key": "config-DELETE-setting"
}
]
}
]
},
"GET": {
"name": "GET",
"all": {
"collection": "config",
"method": "GET",
"resource": -1,
"description": "All GET resources in the config REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "config",
"method": "GET",
"resource": "section",
"description": "Get config section details",
"sensitive": 0
},
{
"collection": "config",
"method": "GET",
"resource": "sections",
"description": "Get available config sections",
"sensitive": 0
}
]
},
"PATCH": {
"name": "PATCH",
"all": {
"collection": "config",
"method": "PATCH",
"resource": -1,
"description": "All PATCH resources in the config REST API collection",
"sensitive_apis": [
{
"collection": "config",
"method": "PATCH",
"resource": "section",
"description": "Update a config section",
"key": "config-PATCH-section"
}
]
},
"resources": [
{
"collection": "config",
"method": "PATCH",
"resource": "affiliate_default",
"description": "Update all affiliates to default for setting",
"sensitive": 0
},
{
"collection": "config",
"method": "PATCH",
"resource": "section",
"description": "Update a config section",
"sensitive": 1,
"sensitive_apis": [
{
"collection": "config",
"method": "PATCH",
"resource": "section",
"description": "Update a config section",
"key": "config-PATCH-section"
}
]
}
]
}
}
},
{
"name": "codes",
"all": {
"collection": "codes",
"method": -1,
"resource": -1,
"description": "Entire codes REST API collection",
"sensitive_apis": []
},
"methods": {
"GET": {
"name": "GET",
"all": {
"collection": "codes",
"method": "GET",
"resource": -1,
"description": "All GET resources in the codes REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "codes",
"method": "GET",
"resource": "affiliate-codes",
"description": "Get a list of NATS code values and links for a specific affiliate and program",
"sensitive": 0
},
{
"collection": "codes",
"method": "GET",
"resource": "decode",
"description": "Decode a particular NATS code value",
"sensitive": 0
},
{
"collection": "codes",
"method": "GET",
"resource": "linkcodes",
"description": "Get link codes for particular for the given parameters",
"sensitive": 0
},
{
"collection": "codes",
"method": "GET",
"resource": "strack",
"description": "Get strack links",
"sensitive": 0
}
]
}
}
},
{
"name": "include",
"all": {
"collection": "include",
"method": -1,
"resource": -1,
"description": "Entire include REST API collection",
"sensitive_apis": []
},
"methods": {
"DELETE": {
"name": "DELETE",
"all": {
"collection": "include",
"method": "DELETE",
"resource": -1,
"description": "All DELETE resources in the include REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "include",
"method": "DELETE",
"resource": "include",
"description": "Delete include chain",
"sensitive": 0
},
{
"collection": "include",
"method": "DELETE",
"resource": "step",
"description": "Delete include chain step",
"sensitive": 0
}
]
},
"GET": {
"name": "GET",
"all": {
"collection": "include",
"method": "GET",
"resource": -1,
"description": "All GET resources in the include REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "include",
"method": "GET",
"resource": "include",
"description": "Get details for an include chain",
"sensitive": 0
},
{
"collection": "include",
"method": "GET",
"resource": "includes",
"description": "Get a list of include chains",
"sensitive": 0
},
{
"collection": "include",
"method": "GET",
"resource": "templates",
"description": null,
"sensitive": 0
}
]
},
"PATCH": {
"name": "PATCH",
"all": {
"collection": "include",
"method": "PATCH",
"resource": -1,
"description": "All PATCH resources in the include REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "include",
"method": "PATCH",
"resource": "include",
"description": "Update include chain",
"sensitive": 0
},
{
"collection": "include",
"method": "PATCH",
"resource": "restore",
"description": "Restore include chain",
"sensitive": 0
},
{
"collection": "include",
"method": "PATCH",
"resource": "step",
"description": "Update include step",
"sensitive": 0
}
]
},
"POST": {
"name": "POST",
"all": {
"collection": "include",
"method": "POST",
"resource": -1,
"description": "All POST resources in the include REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "include",
"method": "POST",
"resource": "include",
"description": "Add new include chain",
"sensitive": 0
},
{
"collection": "include",
"method": "POST",
"resource": "step",
"description": "Add new include step",
"sensitive": 0
}
]
}
}
},
{
"name": "mailing",
"all": {
"collection": "mailing",
"method": -1,
"resource": -1,
"description": "Entire mailing REST API collection",
"sensitive_apis": []
},
"methods": {
"DELETE": {
"name": "DELETE",
"all": {
"collection": "mailing",
"method": "DELETE",
"resource": -1,
"description": "All DELETE resources in the mailing REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "mailing",
"method": "DELETE",
"resource": "mailing",
"description": "Delete maling",
"sensitive": 0
},
{
"collection": "mailing",
"method": "DELETE",
"resource": "mailing-rule",
"description": "Disable mailing rule",
"sensitive": 0
},
{
"collection": "mailing",
"method": "DELETE",
"resource": "queue",
"description": "Delete mail queue entry",
"sensitive": 0
}
]
},
"GET": {
"name": "GET",
"all": {
"collection": "mailing",
"method": "GET",
"resource": -1,
"description": "All GET resources in the mailing REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "mailing",
"method": "GET",
"resource": "mailing",
"description": "Get mailing details",
"sensitive": 0
},
{
"collection": "mailing",
"method": "GET",
"resource": "mailings",
"description": "Get mailings",
"sensitive": 0
},
{
"collection": "mailing",
"method": "GET",
"resource": "mailing-rules",
"description": "Get mailing rules",
"sensitive": 0
},
{
"collection": "mailing",
"method": "GET",
"resource": "mailing-rule",
"description": "Get a mailing rule",
"sensitive": 0
},
{
"collection": "mailing",
"method": "GET",
"resource": "queue",
"description": "Search mail queue",
"sensitive": 0
},
{
"collection": "mailing",
"method": "GET",
"resource": "removelist",
"description": "Get remove list",
"sensitive": 0
}
]
},
"PATCH": {
"name": "PATCH",
"all": {
"collection": "mailing",
"method": "PATCH",
"resource": -1,
"description": "All PATCH resources in the mailing REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "mailing",
"method": "PATCH",
"resource": "mailing",
"description": "Edit mailing",
"sensitive": 0
},
{
"collection": "mailing",
"method": "PATCH",
"resource": "mailing-rule",
"description": "Edit mailer rule",
"sensitive": 0
},
{
"collection": "mailing",
"method": "PATCH",
"resource": "removelist",
"description": "Update email remove list",
"sensitive": 0
},
{
"collection": "mailing",
"method": "PATCH",
"resource": "removelist-queue",
"description": "Add email from mail queue entry to remove list",
"sensitive": 0
},
{
"collection": "mailing",
"method": "PATCH",
"resource": "resend-queue",
"description": "Resend mail queue entry",
"sensitive": 0
},
{
"collection": "mailing",
"method": "PATCH",
"resource": "restore-queue",
"description": "Restore mail queue entry",
"sensitive": 0
},
{
"collection": "mailing",
"method": "PATCH",
"resource": "send-mailing",
"description": "Send mailing now",
"sensitive": 0
},
{
"collection": "mailing",
"method": "PATCH",
"resource": "send-test-mailing",
"description": "Send test mailing",
"sensitive": 0
}
]
},
"POST": {
"name": "POST",
"all": {
"collection": "mailing",
"method": "POST",
"resource": -1,
"description": "All POST resources in the mailing REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "mailing",
"method": "POST",
"resource": "mailing",
"description": "Add new mailing",
"sensitive": 0
},
{
"collection": "mailing",
"method": "POST",
"resource": "mailing-rule",
"description": "Add new mailer rule",
"sensitive": 0
},
{
"collection": "mailing",
"method": "POST",
"resource": "removelist",
"description": "Append to email remove list",
"sensitive": 0
}
]
}
}
},
{
"name": "maintenance",
"all": {
"collection": "maintenance",
"method": -1,
"resource": -1,
"description": "Entire maintenance REST API collection",
"sensitive_apis": [
{
"collection": "maintenance",
"method": "GET",
"resource": "admin-actions",
"description": "Search admin actions",
"key": "maintenance-GET-admin-actions"
},
{
"collection": "maintenance",
"method": "GET",
"resource": "log",
"description": "Get lines from log file",
"key": "maintenance-GET-log"
},
{
"collection": "maintenance",
"method": "PATCH",
"resource": "log",
"description": "Cleanup log file",
"key": "maintenance-PATCH-log"
}
]
},
"methods": {
"DELETE": {
"name": "DELETE",
"all": {
"collection": "maintenance",
"method": "DELETE",
"resource": -1,
"description": "All DELETE resources in the maintenance REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "maintenance",
"method": "DELETE",
"resource": "log",
"description": "Delete log file",
"sensitive": 0
},
{
"collection": "maintenance",
"method": "DELETE",
"resource": "cache",
"description": "Delete report cache",
"sensitive": 0
}
]
},
"GET": {
"name": "GET",
"all": {
"collection": "maintenance",
"method": "GET",
"resource": -1,
"description": "All GET resources in the maintenance REST API collection",
"sensitive_apis": [
{
"collection": "maintenance",
"method": "GET",
"resource": "admin-actions",
"description": "Search admin actions",
"key": "maintenance-GET-admin-actions"
},
{
"collection": "maintenance",
"method": "GET",
"resource": "log",
"description": "Get lines from log file",
"key": "maintenance-GET-log"
}
]
},
"resources": [
{
"collection": "maintenance",
"method": "GET",
"resource": "admin-actions",
"description": "Search admin actions",
"sensitive": 1,
"sensitive_apis": [
{
"collection": "maintenance",
"method": "GET",
"resource": "admin-actions",
"description": "Search admin actions",
"key": "maintenance-GET-admin-actions"
}
]
},
{
"collection": "maintenance",
"method": "GET",
"resource": "admin-actions-filters",
"description": "Get available filter information for admin action API",
"sensitive": 0
},
{
"collection": "maintenance",
"method": "GET",
"resource": "log",
"description": "Get lines from log file",
"sensitive": 1,
"sensitive_apis": [
{
"collection": "maintenance",
"method": "GET",
"resource": "log",
"description": "Get lines from log file",
"key": "maintenance-GET-log"
}
]
},
{
"collection": "maintenance",
"method": "GET",
"resource": "logs",
"description": "Get list of log files",
"sensitive": 0
},
{
"collection": "maintenance",
"method": "GET",
"resource": "nats",
"description": "Get NATS status",
"sensitive": 0
},
{
"collection": "maintenance",
"method": "GET",
"resource": "report",
"description": "Get details on a report table",
"sensitive": 0
},
{
"collection": "maintenance",
"method": "GET",
"resource": "report-progress",
"description": "Get progress on report summary table rebuild",
"sensitive": 0
},
{
"collection": "maintenance",
"method": "GET",
"resource": "reports",
"description": "Get list of report tables",
"sensitive": 0
},
{
"collection": "maintenance",
"method": "GET",
"resource": "server",
"description": "Get server status",
"sensitive": 0
},
{
"collection": "maintenance",
"method": "GET",
"resource": "table",
"description": "Get details on a table",
"sensitive": 0
},
{
"collection": "maintenance",
"method": "GET",
"resource": "tables",
"description": "Search list of NATS tables",
"sensitive": 0
},
{
"collection": "maintenance",
"method": "GET",
"resource": "table-clean-count",
"description": "Get estimated rows for table cleanup",
"sensitive": 0
},
{
"collection": "maintenance",
"method": "GET",
"resource": "table-clean-progress",
"description": "Get table cleanup progress",
"sensitive": 0
}
]
},
"PATCH": {
"name": "PATCH",
"all": {
"collection": "maintenance",
"method": "PATCH",
"resource": -1,
"description": "All PATCH resources in the maintenance REST API collection",
"sensitive_apis": [
{
"collection": "maintenance",
"method": "PATCH",
"resource": "log",
"description": "Cleanup log file",
"key": "maintenance-PATCH-log"
}
]
},
"resources": [
{
"collection": "maintenance",
"method": "PATCH",
"resource": "log",
"description": "Cleanup log file",
"sensitive": 1,
"sensitive_apis": [
{
"collection": "maintenance",
"method": "PATCH",
"resource": "log",
"description": "Cleanup log file",
"key": "maintenance-PATCH-log"
}
]
},
{
"collection": "maintenance",
"method": "PATCH",
"resource": "report",
"description": "Rebuild report summary",
"sensitive": 0
},
{
"collection": "maintenance",
"method": "PATCH",
"resource": "table",
"description": "Cleanup table",
"sensitive": 0
}
]
}
}
},
{
"name": "member",
"all": {
"collection": "member",
"method": -1,
"resource": -1,
"description": "Entire member REST API collection",
"sensitive_apis": []
},
"methods": {
"GET": {
"name": "GET",
"all": {
"collection": "member",
"method": "GET",
"resource": -1,
"description": "All GET resources in the member REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "member",
"method": "GET",
"resource": "available_flags",
"description": "Get flags available to put on a member",
"sensitive": 0
},
{
"collection": "member",
"method": "GET",
"resource": "encryptusername",
"description": "Get an encrypted username for member authentication",
"sensitive": 0
},
{
"collection": "member",
"method": "GET",
"resource": "authstring",
"description": "Get an auth string for a member record for the plus systems",
"sensitive": 0
},
{
"collection": "member",
"method": "GET",
"resource": "details",
"description": "Get member information",
"sensitive": 0
},
{
"collection": "member",
"method": "GET",
"resource": "flags",
"description": null,
"sensitive": 0
},
{
"collection": "member",
"method": "GET",
"resource": "loginlog",
"description": "Get log of logins for a member",
"sensitive": 0
},
{
"collection": "member",
"method": "GET",
"resource": "matching",
"description": "Find matching members for member fields",
"sensitive": 0
},
{
"collection": "member",
"method": "GET",
"resource": "notes",
"description": "Get notes for a member",
"sensitive": 0
},
{
"collection": "member",
"method": "GET",
"resource": "notices",
"description": "Get member notices",
"sensitive": 0
},
{
"collection": "member",
"method": "GET",
"resource": "restricted-values",
"description": "Get restricted values for members",
"sensitive": 0
},
{
"collection": "member",
"method": "GET",
"resource": "search",
"description": "Search for members",
"sensitive": 0
},
{
"collection": "member",
"method": "GET",
"resource": "search-filters",
"description": "Get available filter information for member search API",
"sensitive": 0
},
{
"collection": "member",
"method": "GET",
"resource": "surfer-actions",
"description": "Get surfer actions for a member",
"sensitive": 0
}
]
},
"PATCH": {
"name": "PATCH",
"all": {
"collection": "member",
"method": "PATCH",
"resource": -1,
"description": "All PATCH resources in the member REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "member",
"method": "PATCH",
"resource": "details",
"description": "Update member information",
"sensitive": 0
},
{
"collection": "member",
"method": "PATCH",
"resource": "expiration",
"description": "Set expiration date for a subscription",
"sensitive": 0
},
{
"collection": "member",
"method": "PATCH",
"resource": "expiremanual",
"description": "Expire a manual member",
"sensitive": 0
},
{
"collection": "member",
"method": "PATCH",
"resource": "resend-transaction-email",
"description": "Resend transaction email",
"sensitive": 0
},
{
"collection": "member",
"method": "PATCH",
"resource": "resend-transaction-postback",
"description": "Resend transaction postback",
"sensitive": 0
},
{
"collection": "member",
"method": "PATCH",
"resource": "restricted-value",
"description": "Reactivate a restricted value for member fields",
"sensitive": 0
},
{
"collection": "member",
"method": "PATCH",
"resource": "forget",
"description": "Forget personal data about the member",
"sensitive": 0
},
{
"collection": "member",
"method": "PATCH",
"resource": "lock",
"description": "Lock Member and prevent admin edits",
"sensitive": 0
},
{
"collection": "member",
"method": "PATCH",
"resource": "unlock",
"description": "Unlock locked Member and allow admin edits again",
"sensitive": 0
}
]
},
"POST": {
"name": "POST",
"all": {
"collection": "member",
"method": "POST",
"resource": -1,
"description": "All POST resources in the member REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "member",
"method": "POST",
"resource": "flag",
"description": "Add flag for a member",
"sensitive": 0
},
{
"collection": "member",
"method": "POST",
"resource": "login",
"description": "Record member paysite login",
"sensitive": 0
},
{
"collection": "member",
"method": "POST",
"resource": "manual",
"description": "Create a manual member",
"sensitive": 0
},
{
"collection": "member",
"method": "POST",
"resource": "note",
"description": "Add a member note",
"sensitive": 0
},
{
"collection": "member",
"method": "POST",
"resource": "restricted-value",
"description": "Add restricted value for member fields",
"sensitive": 0
}
]
},
"DELETE": {
"name": "DELETE",
"all": {
"collection": "member",
"method": "DELETE",
"resource": -1,
"description": "All DELETE resources in the member REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "member",
"method": "DELETE",
"resource": "flag",
"description": "Remove flag for a member",
"sensitive": 0
},
{
"collection": "member",
"method": "DELETE",
"resource": "restricted-value",
"description": "Disable a restricted value for member fields",
"sensitive": 0
}
]
}
}
},
{
"name": "message",
"all": {
"collection": "message",
"method": -1,
"resource": -1,
"description": "Entire message REST API collection",
"sensitive_apis": []
},
"methods": {
"DELETE": {
"name": "DELETE",
"all": {
"collection": "message",
"method": "DELETE",
"resource": -1,
"description": "All DELETE resources in the message REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "message",
"method": "DELETE",
"resource": "message",
"description": "Delete message(s)",
"sensitive": 0
},
{
"collection": "message",
"method": "DELETE",
"resource": "permanent",
"description": "Permanently delete all deleted messages",
"sensitive": 0
}
]
},
"GET": {
"name": "GET",
"all": {
"collection": "message",
"method": "GET",
"resource": -1,
"description": "All GET resources in the message REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "message",
"method": "GET",
"resource": "count",
"description": "Get a message count for this account",
"sensitive": 0
},
{
"collection": "message",
"method": "GET",
"resource": "messages",
"description": "Get a messages for this account",
"sensitive": 0
},
{
"collection": "message",
"method": "GET",
"resource": "view",
"description": "Get a message",
"sensitive": 0
}
]
},
"PATCH": {
"name": "PATCH",
"all": {
"collection": "message",
"method": "PATCH",
"resource": -1,
"description": "All PATCH resources in the message REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "message",
"method": "PATCH",
"resource": "read",
"description": "Mark message(s) read",
"sensitive": 0
},
{
"collection": "message",
"method": "PATCH",
"resource": "unread",
"description": "Mark message(s) unread",
"sensitive": 0
},
{
"collection": "message",
"method": "PATCH",
"resource": "undelete",
"description": "Mark message(s) undeleted",
"sensitive": 0
}
]
},
"POST": {
"name": "POST",
"all": {
"collection": "message",
"method": "POST",
"resource": -1,
"description": "All POST resources in the message REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "message",
"method": "POST",
"resource": "message",
"description": "Get a message",
"sensitive": 0
}
]
}
}
},
{
"name": "news",
"all": {
"collection": "news",
"method": -1,
"resource": -1,
"description": "Entire news REST API collection",
"sensitive_apis": []
},
"methods": {
"DELETE": {
"name": "DELETE",
"all": {
"collection": "news",
"method": "DELETE",
"resource": -1,
"description": "All DELETE resources in the news REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "news",
"method": "DELETE",
"resource": "entry",
"description": "Delete news entry",
"sensitive": 0
},
{
"collection": "news",
"method": "DELETE",
"resource": "section",
"description": "Delete news section",
"sensitive": 0
}
]
},
"GET": {
"name": "GET",
"all": {
"collection": "news",
"method": "GET",
"resource": -1,
"description": "All GET resources in the news REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "news",
"method": "GET",
"resource": "entry",
"description": "Get news entry",
"sensitive": 0
},
{
"collection": "news",
"method": "GET",
"resource": "news",
"description": "Get news",
"sensitive": 0
},
{
"collection": "news",
"method": "GET",
"resource": "sections",
"description": "Get news sections",
"sensitive": 0
}
]
},
"PATCH": {
"name": "PATCH",
"all": {
"collection": "news",
"method": "PATCH",
"resource": -1,
"description": "All PATCH resources in the news REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "news",
"method": "PATCH",
"resource": "entry",
"description": "Edit news entry",
"sensitive": 0
}
]
},
"POST": {
"name": "POST",
"all": {
"collection": "news",
"method": "POST",
"resource": -1,
"description": "All POST resources in the news REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "news",
"method": "POST",
"resource": "entry",
"description": "Add news entry",
"sensitive": 0
},
{
"collection": "news",
"method": "POST",
"resource": "section",
"description": "Add news section",
"sensitive": 0
}
]
}
}
},
{
"name": "notification",
"all": {
"collection": "notification",
"method": -1,
"resource": -1,
"description": "Entire notification REST API collection",
"sensitive_apis": []
},
"methods": {
"DELETE": {
"name": "DELETE",
"all": {
"collection": "notification",
"method": "DELETE",
"resource": -1,
"description": "All DELETE resources in the notification REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "notification",
"method": "DELETE",
"resource": "notification",
"description": "Delete notification(s)",
"sensitive": 0
},
{
"collection": "notification",
"method": "DELETE",
"resource": "permanent",
"description": "Permanently delete all deleted notifications",
"sensitive": 0
}
]
},
"GET": {
"name": "GET",
"all": {
"collection": "notification",
"method": "GET",
"resource": -1,
"description": "All GET resources in the notification REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "notification",
"method": "GET",
"resource": "count",
"description": "Get a notification count for this account",
"sensitive": 0
},
{
"collection": "notification",
"method": "GET",
"resource": "notifications",
"description": "Get a notifications for this account",
"sensitive": 0
},
{
"collection": "notification",
"method": "GET",
"resource": "view",
"description": "Get a notification",
"sensitive": 0
}
]
},
"PATCH": {
"name": "PATCH",
"all": {
"collection": "notification",
"method": "PATCH",
"resource": -1,
"description": "All PATCH resources in the notification REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "notification",
"method": "PATCH",
"resource": "read",
"description": "Mark notification(s) read",
"sensitive": 0
},
{
"collection": "notification",
"method": "PATCH",
"resource": "unread",
"description": "Mark notification(s) unread",
"sensitive": 0
},
{
"collection": "notification",
"method": "PATCH",
"resource": "undelete",
"description": "Mark notification(s) undeleted",
"sensitive": 0
}
]
}
}
},
{
"name": "option",
"all": {
"collection": "option",
"method": -1,
"resource": -1,
"description": "Entire option REST API collection",
"sensitive_apis": []
},
"methods": {
"GET": {
"name": "GET",
"all": {
"collection": "option",
"method": "GET",
"resource": -1,
"description": "All GET resources in the option REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "option",
"method": "GET",
"resource": "options",
"description": "Get a list of join options for a particular NATS code value",
"sensitive": 0
},
{
"collection": "option",
"method": "GET",
"resource": "rule",
"description": "Get rules for a particular join option",
"sensitive": 0
}
]
},
"PATCH": {
"name": "PATCH",
"all": {
"collection": "option",
"method": "PATCH",
"resource": -1,
"description": "All PATCH resources in the option REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "option",
"method": "PATCH",
"resource": "rule",
"description": "Edit a given join option rule",
"sensitive": 0
},
{
"collection": "option",
"method": "PATCH",
"resource": "text",
"description": "Edit text for a given join option",
"sensitive": 0
}
]
},
"POST": {
"name": "POST",
"all": {
"collection": "option",
"method": "POST",
"resource": -1,
"description": "All POST resources in the option REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "option",
"method": "POST",
"resource": "rule",
"description": "Add a rule for a given join option",
"sensitive": 0
}
]
}
}
},
{
"name": "payment",
"all": {
"collection": "payment",
"method": -1,
"resource": -1,
"description": "Entire payment REST API collection",
"sensitive_apis": []
},
"methods": {
"DELETE": {
"name": "DELETE",
"all": {
"collection": "payment",
"method": "DELETE",
"resource": -1,
"description": "All DELETE resources in the payment REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "payment",
"method": "DELETE",
"resource": "invoice",
"description": "Delete invoice",
"sensitive": 0
},
{
"collection": "payment",
"method": "DELETE",
"resource": "payout-period",
"description": "delete payout period",
"sensitive": 0
},
{
"collection": "payment",
"method": "DELETE",
"resource": "payvia-field",
"description": "delete payvia field",
"sensitive": 0
},
{
"collection": "payment",
"method": "DELETE",
"resource": "payvia-field-mc",
"description": "Delete payvia field multiple choice option",
"sensitive": 0
},
{
"collection": "payment",
"method": "DELETE",
"resource": "payvia-rule",
"description": "Disable payvia rule",
"sensitive": 0
}
]
},
"GET": {
"name": "GET",
"all": {
"collection": "payment",
"method": "GET",
"resource": -1,
"description": "All GET resources in the payment REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "payment",
"method": "GET",
"resource": "dump-format",
"description": "Get dump format",
"sensitive": 0
},
{
"collection": "payment",
"method": "GET",
"resource": "dump-formats",
"description": "Get dump formats available for payvias",
"sensitive": 0
},
{
"collection": "payment",
"method": "GET",
"resource": "invoices",
"description": "Current manual invoices for affilaite",
"sensitive": 0
},
{
"collection": "payment",
"method": "GET",
"resource": "payments",
"description": "Get payment details",
"sensitive": 0
},
{
"collection": "payment",
"method": "GET",
"resource": "payment-dumps",
"description": "Get payment dumps list",
"sensitive": 0
},
{
"collection": "payment",
"method": "GET",
"resource": "payment-dump",
"description": "Get payment dump",
"sensitive": 0
},
{
"collection": "payment",
"method": "GET",
"resource": "payment-search",
"description": "Search payments",
"sensitive": 0
},
{
"collection": "payment",
"method": "GET",
"resource": "payment-search-filters",
"description": "Get available filter information for payment search API",
"sensitive": 0
},
{
"collection": "payment",
"method": "GET",
"resource": "payvia",
"description": "Get payvia details",
"sensitive": 0
},
{
"collection": "payment",
"method": "GET",
"resource": "payvias",
"description": "Get payvia types",
"sensitive": 0
},
{
"collection": "payment",
"method": "GET",
"resource": "payvia-fields",
"description": "Get payvia fields",
"sensitive": 0
},
{
"collection": "payment",
"method": "GET",
"resource": "payvia-field-mcs",
"description": "Get payvia fields",
"sensitive": 0
},
{
"collection": "payment",
"method": "GET",
"resource": "payout-period",
"description": "Get payout period details",
"sensitive": 0
},
{
"collection": "payment",
"method": "GET",
"resource": "payout-periods",
"description": "Get payout periods",
"sensitive": 0
},
{
"collection": "payment",
"method": "GET",
"resource": "payvia-rules",
"description": null,
"sensitive": 0
},
{
"collection": "payment",
"method": "GET",
"resource": "payvia-rule",
"description": null,
"sensitive": 0
},
{
"collection": "payment",
"method": "GET",
"resource": "payviarule",
"description": "Get rules for a specific payvia type (legacy)",
"sensitive": 0
}
]
},
"PATCH": {
"name": "PATCH",
"all": {
"collection": "payment",
"method": "PATCH",
"resource": -1,
"description": "All PATCH resources in the payment REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "payment",
"method": "PATCH",
"resource": "copy-dump-format",
"description": "Copy payvia dump format",
"sensitive": 0
},
{
"collection": "payment",
"method": "PATCH",
"resource": "default-payout-period",
"description": "Set payout period as the default",
"sensitive": 0
},
{
"collection": "payment",
"method": "PATCH",
"resource": "dump-format",
"description": "Edit payvia dump format",
"sensitive": 0
},
{
"collection": "payment",
"method": "PATCH",
"resource": "duplicate-payvia",
"description": "Copy payvia type",
"sensitive": 0
},
{
"collection": "payment",
"method": "PATCH",
"resource": "invoice",
"description": "Update invoice",
"sensitive": 0
},
{
"collection": "payment",
"method": "PATCH",
"resource": "payment",
"description": "Update payment",
"sensitive": 0
},
{
"collection": "payment",
"method": "PATCH",
"resource": "payment-paid",
"description": "Mark Payment as paid",
"sensitive": 0
},
{
"collection": "payment",
"method": "PATCH",
"resource": "payment-store",
"description": "Store payment",
"sensitive": 0
},
{
"collection": "payment",
"method": "PATCH",
"resource": "payment-unstore",
"description": "Unstore payment",
"sensitive": 0
},
{
"collection": "payment",
"method": "PATCH",
"resource": "payments",
"description": "Update payment status",
"sensitive": 0
},
{
"collection": "payment",
"method": "PATCH",
"resource": "payments-unstore",
"description": "Unstore payments",
"sensitive": 0
},
{
"collection": "payment",
"method": "PATCH",
"resource": "payout-period",
"description": "Edit payout period",
"sensitive": 0
},
{
"collection": "payment",
"method": "PATCH",
"resource": "payout-period-affiliates",
"description": "Enable\/disable payout period for affiliates",
"sensitive": 0
},
{
"collection": "payment",
"method": "PATCH",
"resource": "payvia",
"description": "Edit payvia type",
"sensitive": 0
},
{
"collection": "payment",
"method": "PATCH",
"resource": "payvia-field",
"description": "Edit payvia field",
"sensitive": 0
},
{
"collection": "payment",
"method": "PATCH",
"resource": "payvia-fields-reorder",
"description": "Reorder payvia fields",
"sensitive": 0
},
{
"collection": "payment",
"method": "PATCH",
"resource": "payvia-field-mc",
"description": "Edit payvia field multiple choice option",
"sensitive": 0
},
{
"collection": "payment",
"method": "PATCH",
"resource": "payvia-field-mcs-reorder",
"description": "Reorder payvia field multiple choice options",
"sensitive": 0
},
{
"collection": "payment",
"method": "PATCH",
"resource": "payvia-rule",
"description": "Edit payvia rule",
"sensitive": 0
},
{
"collection": "payment",
"method": "PATCH",
"resource": "payviarule",
"description": "Create\/Modify rules for payvia types",
"sensitive": 0
},
{
"collection": "payment",
"method": "PATCH",
"resource": "restore-payout-period",
"description": "Restore deleted payout period",
"sensitive": 0
},
{
"collection": "payment",
"method": "PATCH",
"resource": "restore-payvia-field",
"description": "Restore deleted payvia field",
"sensitive": 0
},
{
"collection": "payment",
"method": "PATCH",
"resource": "restore-payvia-field-mc",
"description": "Restore payvia field multiple choice option",
"sensitive": 0
}
]
},
"POST": {
"name": "POST",
"all": {
"collection": "payment",
"method": "POST",
"resource": -1,
"description": "All POST resources in the payment REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "payment",
"method": "POST",
"resource": "check-dump",
"description": "Check bulk payment dump prior to importing",
"sensitive": 0
},
{
"collection": "payment",
"method": "POST",
"resource": "dump-format",
"description": "Add new payvia dump format",
"sensitive": 0
},
{
"collection": "payment",
"method": "POST",
"resource": "import-dump",
"description": "Process bulk payment dump prior to importing",
"sensitive": 0
},
{
"collection": "payment",
"method": "POST",
"resource": "invoice",
"description": "Add invoice",
"sensitive": 0
},
{
"collection": "payment",
"method": "POST",
"resource": "payout-period",
"description": "Add new payout period",
"sensitive": 0
},
{
"collection": "payment",
"method": "POST",
"resource": "payvia",
"description": "Add new payvia type",
"sensitive": 0
},
{
"collection": "payment",
"method": "POST",
"resource": "payvia-field",
"description": "Add new payvia field",
"sensitive": 0
},
{
"collection": "payment",
"method": "POST",
"resource": "payvia-field-mc",
"description": "Add new payvia field multiple choice option",
"sensitive": 0
},
{
"collection": "payment",
"method": "POST",
"resource": "payvia-rule",
"description": "Add new payvia rule",
"sensitive": 0
}
]
}
}
},
{
"name": "program",
"all": {
"collection": "program",
"method": -1,
"resource": -1,
"description": "Entire program REST API collection",
"sensitive_apis": []
},
"methods": {
"DELETE": {
"name": "DELETE",
"all": {
"collection": "program",
"method": "DELETE",
"resource": -1,
"description": "All DELETE resources in the program REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "program",
"method": "DELETE",
"resource": "program",
"description": "Delete program",
"sensitive": 0
},
{
"collection": "program",
"method": "DELETE",
"resource": "payout-change",
"description": "Delete payout change",
"sensitive": 0
},
{
"collection": "program",
"method": "DELETE",
"resource": "payout-change-tier",
"description": "Delete payout change tier",
"sensitive": 0
}
]
},
"GET": {
"name": "GET",
"all": {
"collection": "program",
"method": "GET",
"resource": -1,
"description": "All GET resources in the program REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "program",
"method": "GET",
"resource": "additional-payout-change-targets",
"description": "Get additional payout change fields for selected program",
"sensitive": 0
},
{
"collection": "program",
"method": "GET",
"resource": "affiliate-available",
"description": "Get programs available for affiliate",
"sensitive": 0
},
{
"collection": "program",
"method": "GET",
"resource": "detail",
"description": "Get details for specific program",
"sensitive": 0
},
{
"collection": "program",
"method": "GET",
"resource": "list",
"description": "Get a list of programs",
"sensitive": 0
},
{
"collection": "program",
"method": "GET",
"resource": "options",
"description": "Get options for program",
"sensitive": 0
},
{
"collection": "program",
"method": "GET",
"resource": "payout-changes",
"description": "Get payout changes for program",
"sensitive": 0
},
{
"collection": "program",
"method": "GET",
"resource": "redirect-available",
"description": "Get available programs for program redirect",
"sensitive": 0
},
{
"collection": "program",
"method": "GET",
"resource": "sites",
"description": "Get sites for program",
"sensitive": 0
},
{
"collection": "program",
"method": "GET",
"resource": "tours",
"description": "Get tours for program",
"sensitive": 0
},
{
"collection": "program",
"method": "GET",
"resource": "types",
"description": "Get program types",
"sensitive": 0
}
]
},
"PATCH": {
"name": "PATCH",
"all": {
"collection": "program",
"method": "PATCH",
"resource": -1,
"description": "All PATCH resources in the program REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "program",
"method": "PATCH",
"resource": "default_payout",
"description": "Edit default payout for program",
"sensitive": 0
},
{
"collection": "program",
"method": "PATCH",
"resource": "details",
"description": "Edit program",
"sensitive": 0
},
{
"collection": "program",
"method": "PATCH",
"resource": "disable_affiliate",
"description": "Disable affiliate in program",
"sensitive": 0
},
{
"collection": "program",
"method": "PATCH",
"resource": "disable_tour",
"description": null,
"sensitive": 0
},
{
"collection": "program",
"method": "PATCH",
"resource": "enable_affiliate",
"description": "Disable affiliate in program",
"sensitive": 0
},
{
"collection": "program",
"method": "PATCH",
"resource": "enable_site",
"description": "Enable site in program",
"sensitive": 0
},
{
"collection": "program",
"method": "PATCH",
"resource": "enable_tour",
"description": "Enable tour in program",
"sensitive": 0
},
{
"collection": "program",
"method": "PATCH",
"resource": "move-payout-change",
"description": "Move payout change order",
"sensitive": 0
},
{
"collection": "program",
"method": "PATCH",
"resource": "payout-change",
"description": "Edit program payout change",
"sensitive": 0
},
{
"collection": "program",
"method": "PATCH",
"resource": "payout-change-tier",
"description": "Edit payout tier chnage",
"sensitive": 0
}
]
},
"POST": {
"name": "POST",
"all": {
"collection": "program",
"method": "POST",
"resource": -1,
"description": "All POST resources in the program REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "program",
"method": "POST",
"resource": "new",
"description": "Add new program",
"sensitive": 0
},
{
"collection": "program",
"method": "POST",
"resource": "payout-change",
"description": "Add new program payout change",
"sensitive": 0
},
{
"collection": "program",
"method": "POST",
"resource": "payout-change-tier",
"description": "Add new tier to program payout change",
"sensitive": 0
}
]
}
}
},
{
"name": "report",
"all": {
"collection": "report",
"method": -1,
"resource": -1,
"description": "Entire report REST API collection",
"sensitive_apis": []
},
"methods": {
"GET": {
"name": "GET",
"all": {
"collection": "report",
"method": "GET",
"resource": -1,
"description": "All GET resources in the report REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "report",
"method": "GET",
"resource": "affiliate-ratios",
"description": "Get the affiliate ratios report",
"sensitive": 0
},
{
"collection": "report",
"method": "GET",
"resource": "hits",
"description": "Get raw hit data",
"sensitive": 0
},
{
"collection": "report",
"method": "GET",
"resource": "hit-totals",
"description": "Get hit totals for today",
"sensitive": 0
},
{
"collection": "report",
"method": "GET",
"resource": "profitloss",
"description": "Get the profit\/loss report (legacy)",
"sensitive": 0
},
{
"collection": "report",
"method": "GET",
"resource": "profit-loss",
"description": "Get the profit\/loss report",
"sensitive": 0
},
{
"collection": "report",
"method": "GET",
"resource": "fields",
"description": "Get available report fields",
"sensitive": 0
},
{
"collection": "report",
"method": "GET",
"resource": "focus",
"description": "Get available report focus details",
"sensitive": 0
},
{
"collection": "report",
"method": "GET",
"resource": "focuses",
"description": "Get available report focuses",
"sensitive": 0
},
{
"collection": "report",
"method": "GET",
"resource": "groups",
"description": "Get report groups",
"sensitive": 0
},
{
"collection": "report",
"method": "GET",
"resource": "perspective",
"description": "Get report perspective details",
"sensitive": 0
},
{
"collection": "report",
"method": "GET",
"resource": "perspectives",
"description": "Get report perspectives",
"sensitive": 0
},
{
"collection": "report",
"method": "GET",
"resource": "report",
"description": "Get report information",
"sensitive": 0
},
{
"collection": "report",
"method": "GET",
"resource": "subscription",
"description": "Get the subscription report",
"sensitive": 0
},
{
"collection": "report",
"method": "GET",
"resource": "surfer",
"description": "Get the surfer action report",
"sensitive": 0
},
{
"collection": "report",
"method": "GET",
"resource": "surferaction",
"description": "Get surfer actions (legacy)",
"sensitive": 0
},
{
"collection": "report",
"method": "GET",
"resource": "transactionpayouts",
"description": "Get raw payout data",
"sensitive": 0
},
{
"collection": "report",
"method": "GET",
"resource": "transactions",
"description": "Get raw transaction data",
"sensitive": 0
},
{
"collection": "report",
"method": "GET",
"resource": "transaction",
"description": "Get the transaction report",
"sensitive": 0
},
{
"collection": "report",
"method": "GET",
"resource": "report-widget",
"description": "Get report widget details",
"sensitive": 0
},
{
"collection": "report",
"method": "GET",
"resource": "widgets",
"description": "Get widgets for overview and their settings",
"sensitive": 0
},
{
"collection": "report",
"method": "GET",
"resource": "widget",
"description": "Get widget settings",
"sensitive": 0
},
{
"collection": "report",
"method": "GET",
"resource": "widget-info",
"description": "Get available info for overview widget",
"sensitive": 0
},
{
"collection": "report",
"method": "GET",
"resource": "views",
"description": "Get available report views",
"sensitive": 0
}
]
},
"POST": {
"name": "POST",
"all": {
"collection": "report",
"method": "POST",
"resource": -1,
"description": "All POST resources in the report REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "report",
"method": "POST",
"resource": "focus",
"description": "Add new report focus",
"sensitive": 0
},
{
"collection": "report",
"method": "POST",
"resource": "group",
"description": "Add new report group",
"sensitive": 0
},
{
"collection": "report",
"method": "POST",
"resource": "perspective",
"description": "Add new report perspective",
"sensitive": 0
}
]
},
"PATCH": {
"name": "PATCH",
"all": {
"collection": "report",
"method": "PATCH",
"resource": -1,
"description": "All PATCH resources in the report REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "report",
"method": "PATCH",
"resource": "focus",
"description": "Edit report focus",
"sensitive": 0
},
{
"collection": "report",
"method": "PATCH",
"resource": "focus-enabled",
"description": "Change report focus to enabled or disabled",
"sensitive": 0
},
{
"collection": "report",
"method": "PATCH",
"resource": "focus-default",
"description": "Change report focus to be default for display",
"sensitive": 0
},
{
"collection": "report",
"method": "PATCH",
"resource": "focuses-reorder",
"description": "Change order of report_focuses",
"sensitive": 0
},
{
"collection": "report",
"method": "PATCH",
"resource": "perspective",
"description": "Update report perspective",
"sensitive": 0
},
{
"collection": "report",
"method": "PATCH",
"resource": "perspective-group",
"description": "Update report perspective group",
"sensitive": 0
},
{
"collection": "report",
"method": "PATCH",
"resource": "report-widget",
"description": "Edit report widget",
"sensitive": 0
},
{
"collection": "report",
"method": "PATCH",
"resource": "widget",
"description": "Edit report widget",
"sensitive": 0
}
]
},
"DELETE": {
"name": "DELETE",
"all": {
"collection": "report",
"method": "DELETE",
"resource": -1,
"description": "All DELETE resources in the report REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "report",
"method": "DELETE",
"resource": "focus",
"description": "Delete report focus",
"sensitive": 0
}
]
}
}
},
{
"name": "reward",
"all": {
"collection": "reward",
"method": -1,
"resource": -1,
"description": "Entire reward REST API collection",
"sensitive_apis": []
},
"methods": {
"DELETE": {
"name": "DELETE",
"all": {
"collection": "reward",
"method": "DELETE",
"resource": -1,
"description": "All DELETE resources in the reward REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "reward",
"method": "DELETE",
"resource": "category",
"description": "Delete category",
"sensitive": 0
},
{
"collection": "reward",
"method": "DELETE",
"resource": "purchase",
"description": "Refund purchase",
"sensitive": 0
},
{
"collection": "reward",
"method": "DELETE",
"resource": "point",
"description": "Delete point change",
"sensitive": 0
},
{
"collection": "reward",
"method": "DELETE",
"resource": "reward",
"description": "Delete reward",
"sensitive": 0
}
]
},
"GET": {
"name": "GET",
"all": {
"collection": "reward",
"method": "GET",
"resource": -1,
"description": "All GET resources in the reward REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "reward",
"method": "GET",
"resource": "categories",
"description": "Get reward categories",
"sensitive": 0
},
{
"collection": "reward",
"method": "GET",
"resource": "points",
"description": "Get point payouts",
"sensitive": 0
},
{
"collection": "reward",
"method": "GET",
"resource": "purchases",
"description": "Get affiliate purchases",
"sensitive": 0
},
{
"collection": "reward",
"method": "GET",
"resource": "rewards",
"description": "Get rewards",
"sensitive": 0
}
]
},
"PATCH": {
"name": "PATCH",
"all": {
"collection": "reward",
"method": "PATCH",
"resource": -1,
"description": "All PATCH resources in the reward REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "reward",
"method": "PATCH",
"resource": "move-point",
"description": "Move point change order",
"sensitive": 0
},
{
"collection": "reward",
"method": "PATCH",
"resource": "point",
"description": "Edit point payout",
"sensitive": 0
},
{
"collection": "reward",
"method": "PATCH",
"resource": "reward",
"description": "Edit reward",
"sensitive": 0
},
{
"collection": "reward",
"method": "PATCH",
"resource": "ship-purchase",
"description": "Ship purchase",
"sensitive": 0
},
{
"collection": "reward",
"method": "PATCH",
"resource": "unship-purchase",
"description": "Unship purchase",
"sensitive": 0
}
]
},
"POST": {
"name": "POST",
"all": {
"collection": "reward",
"method": "POST",
"resource": -1,
"description": "All POST resources in the reward REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "reward",
"method": "POST",
"resource": "category",
"description": "Add reward category",
"sensitive": 0
},
{
"collection": "reward",
"method": "POST",
"resource": "point",
"description": "Add new point payout",
"sensitive": 0
},
{
"collection": "reward",
"method": "POST",
"resource": "reward",
"description": "Add new reward",
"sensitive": 0
}
]
}
}
},
{
"name": "service",
"all": {
"collection": "service",
"method": -1,
"resource": -1,
"description": "Entire service REST API collection",
"sensitive_apis": []
},
"methods": {
"GET": {
"name": "GET",
"all": {
"collection": "service",
"method": "GET",
"resource": -1,
"description": "All GET resources in the service REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "service",
"method": "GET",
"resource": "brands",
"description": "Get a list of NATS brands",
"sensitive": 0
},
{
"collection": "service",
"method": "GET",
"resource": "check-functions",
"description": "Get a list of NATS supported check functions",
"sensitive": 0
},
{
"collection": "service",
"method": "GET",
"resource": "condition",
"description": "Get the info for condition field",
"sensitive": 0
},
{
"collection": "service",
"method": "GET",
"resource": "countries",
"description": "Get a list of NATS supported countries",
"sensitive": 0
},
{
"collection": "service",
"method": "GET",
"resource": "country",
"description": "Get current country (using GEOIP)",
"sensitive": 0
},
{
"collection": "service",
"method": "GET",
"resource": "datetime",
"description": "Get a formatted NATS date string, optionally providing a timestamp or a preferred format",
"sensitive": 0
},
{
"collection": "service",
"method": "GET",
"resource": "languages",
"description": "Get a list of NATS supported languages",
"sensitive": 0
},
{
"collection": "service",
"method": "GET",
"resource": "periods",
"description": "Get a list of NATS date period types",
"sensitive": 0
},
{
"collection": "service",
"method": "GET",
"resource": "ping",
"description": "Test the api connection",
"sensitive": 0
},
{
"collection": "service",
"method": "GET",
"resource": "project",
"description": "Get information on this NATS project",
"sensitive": 0
},
{
"collection": "service",
"method": "GET",
"resource": "rule-condition-data",
"description": "Get the info for rule conditions",
"sensitive": 0
},
{
"collection": "service",
"method": "GET",
"resource": "rule-info",
"description": "Get the info for building rules",
"sensitive": 0
},
{
"collection": "service",
"method": "GET",
"resource": "stats-breakdowns",
"description": "Get a list of NATS stats breakdowns",
"sensitive": 0
},
{
"collection": "service",
"method": "GET",
"resource": "timezone",
"description": "Get the NATS timezone",
"sensitive": 0
},
{
"collection": "service",
"method": "GET",
"resource": "timestamp",
"description": "Get the NATS timestamp, optionall for a given date",
"sensitive": 0
}
]
},
"POST": {
"name": "POST",
"all": {
"collection": "service",
"method": "POST",
"resource": -1,
"description": "All POST resources in the service REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "service",
"method": "POST",
"resource": "sendemail",
"description": "Send an email to an affiliate or a member",
"sensitive": 0
}
]
}
}
},
{
"name": "site",
"all": {
"collection": "site",
"method": -1,
"resource": -1,
"description": "Entire site REST API collection",
"sensitive_apis": [
{
"collection": "site",
"method": "POST",
"resource": "copy-template",
"description": "Copy template",
"key": "site-POST-copy-template"
},
{
"collection": "site",
"method": "PATCH",
"resource": "template",
"description": "Edit template",
"key": "site-PATCH-template"
},
{
"collection": "site",
"method": "DELETE",
"resource": "template",
"description": "Revert template",
"key": "site-DELETE-template"
}
]
},
"methods": {
"GET": {
"name": "GET",
"all": {
"collection": "site",
"method": "GET",
"resource": -1,
"description": "All GET resources in the site REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "site",
"method": "GET",
"resource": "base-templates",
"description": "Get base site template list",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "billers",
"description": "Get available billers for option type",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "cookies",
"description": "Get cookie settings",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "coupon",
"description": "Get a site coupon",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "coupons",
"description": "Get list of site coupons",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "coupon-revisions",
"description": "Get coupon revisions",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "email-settings",
"description": "Get email settings",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "groups",
"description": "Get site groups",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "option",
"description": "Get option details",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "options",
"description": "Get join options",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "options-available",
"description": "Get available options",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "option-fields",
"description": "Get join option fields",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "option-rules",
"description": null,
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "option-rule",
"description": null,
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "option-type",
"description": "Get option types",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "option-types",
"description": "Get option types",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "programs",
"description": "Get site\/tour program details",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "site-list",
"description": "Get list of sites with limited details",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "site",
"description": "Get site details",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "site-notices",
"description": "Get site notices",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "site-partner",
"description": "Get site partner",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "site-partners",
"description": "Get site partners",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "site-type",
"description": "Get site type",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "sites",
"description": "Get list of sites",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "template",
"description": "Get site template details",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "templates",
"description": "Get site template list",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "template-sections",
"description": "Get site template sections",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "template-sites",
"description": "Get list of sites",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "tour",
"description": "Get tour details",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "tours",
"description": "Get tours",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "tour-emails",
"description": "Get emails for a tour",
"sensitive": 0
},
{
"collection": "site",
"method": "GET",
"resource": "tour-notices",
"description": "Get notices for a tour",
"sensitive": 0
}
]
},
"POST": {
"name": "POST",
"all": {
"collection": "site",
"method": "POST",
"resource": -1,
"description": "All POST resources in the site REST API collection",
"sensitive_apis": [
{
"collection": "site",
"method": "POST",
"resource": "copy-template",
"description": "Copy template",
"key": "site-POST-copy-template"
}
]
},
"resources": [
{
"collection": "site",
"method": "POST",
"resource": "coupon",
"description": "Add new site coupon",
"sensitive": 0
},
{
"collection": "site",
"method": "POST",
"resource": "group",
"description": "Add new site group",
"sensitive": 0
},
{
"collection": "site",
"method": "POST",
"resource": "option",
"description": "Add join option",
"sensitive": 0
},
{
"collection": "site",
"method": "POST",
"resource": "option-rule",
"description": "Add new option rule",
"sensitive": 0
},
{
"collection": "site",
"method": "POST",
"resource": "site-partner",
"description": "Add new site partner",
"sensitive": 0
},
{
"collection": "site",
"method": "POST",
"resource": "site-tour",
"description": "Add new site and default tour",
"sensitive": 0
},
{
"collection": "site",
"method": "POST",
"resource": "copy-template",
"description": "Copy template",
"sensitive": 1,
"sensitive_apis": [
{
"collection": "site",
"method": "POST",
"resource": "copy-template",
"description": "Copy template",
"key": "site-POST-copy-template"
}
]
},
{
"collection": "site",
"method": "POST",
"resource": "tour",
"description": "Add new tour",
"sensitive": 0
}
]
},
"PATCH": {
"name": "PATCH",
"all": {
"collection": "site",
"method": "PATCH",
"resource": -1,
"description": "All PATCH resources in the site REST API collection",
"sensitive_apis": [
{
"collection": "site",
"method": "PATCH",
"resource": "template",
"description": "Edit template",
"key": "site-PATCH-template"
}
]
},
"resources": [
{
"collection": "site",
"method": "PATCH",
"resource": "cookie",
"description": "Set cookie setting",
"sensitive": 0
},
{
"collection": "site",
"method": "PATCH",
"resource": "coupon",
"description": "Edit site coupon",
"sensitive": 0
},
{
"collection": "site",
"method": "PATCH",
"resource": "duplicate-option",
"description": "Duplicate join option",
"sensitive": 0
},
{
"collection": "site",
"method": "PATCH",
"resource": "email-settings",
"description": "Update site email settings",
"sensitive": 0
},
{
"collection": "site",
"method": "PATCH",
"resource": "group",
"description": "Update site group",
"sensitive": 0
},
{
"collection": "site",
"method": "PATCH",
"resource": "move",
"description": "Move item to new location",
"sensitive": 0
},
{
"collection": "site",
"method": "PATCH",
"resource": "option",
"description": "Edit join option",
"sensitive": 0
},
{
"collection": "site",
"method": "PATCH",
"resource": "option-rule",
"description": "Edit option rule",
"sensitive": 0
},
{
"collection": "site",
"method": "PATCH",
"resource": "reset-coupon",
"description": "Reset site coupon redemptions",
"sensitive": 0
},
{
"collection": "site",
"method": "PATCH",
"resource": "restore-group",
"description": "Restore site group",
"sensitive": 0
},
{
"collection": "site",
"method": "PATCH",
"resource": "restore-option",
"description": "Restore join option",
"sensitive": 0
},
{
"collection": "site",
"method": "PATCH",
"resource": "restore-site",
"description": "Restore site",
"sensitive": 0
},
{
"collection": "site",
"method": "PATCH",
"resource": "restore-site-partner",
"description": "Delete site partner",
"sensitive": 0
},
{
"collection": "site",
"method": "PATCH",
"resource": "restore-tour",
"description": "Restore tour",
"sensitive": 0
},
{
"collection": "site",
"method": "PATCH",
"resource": "site",
"description": "Update site settings",
"sensitive": 0
},
{
"collection": "site",
"method": "PATCH",
"resource": "site-partner",
"description": "Update a site partner",
"sensitive": 0
},
{
"collection": "site",
"method": "PATCH",
"resource": "template",
"description": "Edit template",
"sensitive": 1,
"sensitive_apis": [
{
"collection": "site",
"method": "PATCH",
"resource": "template",
"description": "Edit template",
"key": "site-PATCH-template"
}
]
},
{
"collection": "site",
"method": "PATCH",
"resource": "tour",
"description": "Edit tour",
"sensitive": 0
}
]
},
"DELETE": {
"name": "DELETE",
"all": {
"collection": "site",
"method": "DELETE",
"resource": -1,
"description": "All DELETE resources in the site REST API collection",
"sensitive_apis": [
{
"collection": "site",
"method": "DELETE",
"resource": "template",
"description": "Revert template",
"key": "site-DELETE-template"
}
]
},
"resources": [
{
"collection": "site",
"method": "DELETE",
"resource": "cookie",
"description": "Delete cookie setting",
"sensitive": 0
},
{
"collection": "site",
"method": "DELETE",
"resource": "group",
"description": "Delete site group",
"sensitive": 0
},
{
"collection": "site",
"method": "DELETE",
"resource": "option",
"description": "Delete join option",
"sensitive": 0
},
{
"collection": "site",
"method": "DELETE",
"resource": "option-rule",
"description": "Disable option rule",
"sensitive": 0
},
{
"collection": "site",
"method": "DELETE",
"resource": "site",
"description": "Delete tour",
"sensitive": 0
},
{
"collection": "site",
"method": "DELETE",
"resource": "site-partner",
"description": "Delete site partner",
"sensitive": 0
},
{
"collection": "site",
"method": "DELETE",
"resource": "template",
"description": "Revert template",
"sensitive": 1,
"sensitive_apis": [
{
"collection": "site",
"method": "DELETE",
"resource": "template",
"description": "Revert template",
"key": "site-DELETE-template"
}
]
},
{
"collection": "site",
"method": "DELETE",
"resource": "tour",
"description": "Delete tour",
"sensitive": 0
},
{
"collection": "site",
"method": "DELETE",
"resource": "tour-field",
"description": "Revert tour field",
"sensitive": 0
}
]
}
}
},
{
"name": "skin",
"all": {
"collection": "skin",
"method": -1,
"resource": -1,
"description": "Entire skin REST API collection",
"sensitive_apis": [
{
"collection": "skin",
"method": "DELETE",
"resource": "skin",
"description": "Delete skin",
"key": "skin-DELETE-skin"
},
{
"collection": "skin",
"method": "DELETE",
"resource": "template",
"description": "Revert template",
"key": "skin-DELETE-template"
},
{
"collection": "skin",
"method": "PATCH",
"resource": "skin",
"description": "Edit skin",
"key": "skin-PATCH-skin"
},
{
"collection": "skin",
"method": "PATCH",
"resource": "template",
"description": "Edit template",
"key": "skin-PATCH-template"
},
{
"collection": "skin",
"method": "POST",
"resource": "import",
"description": "Import backed up skin",
"key": "skin-POST-import"
},
{
"collection": "skin",
"method": "POST",
"resource": "skin",
"description": "Add new skin",
"key": "skin-POST-skin"
},
{
"collection": "skin",
"method": "POST",
"resource": "template",
"description": "Add new template",
"key": "skin-POST-template"
}
]
},
"methods": {
"DELETE": {
"name": "DELETE",
"all": {
"collection": "skin",
"method": "DELETE",
"resource": -1,
"description": "All DELETE resources in the skin REST API collection",
"sensitive_apis": [
{
"collection": "skin",
"method": "DELETE",
"resource": "skin",
"description": "Delete skin",
"key": "skin-DELETE-skin"
},
{
"collection": "skin",
"method": "DELETE",
"resource": "template",
"description": "Revert template",
"key": "skin-DELETE-template"
}
]
},
"resources": [
{
"collection": "skin",
"method": "DELETE",
"resource": "skin",
"description": "Delete skin",
"sensitive": 1,
"sensitive_apis": [
{
"collection": "skin",
"method": "DELETE",
"resource": "skin",
"description": "Delete skin",
"key": "skin-DELETE-skin"
}
]
},
{
"collection": "skin",
"method": "DELETE",
"resource": "template",
"description": "Revert template",
"sensitive": 1,
"sensitive_apis": [
{
"collection": "skin",
"method": "DELETE",
"resource": "template",
"description": "Revert template",
"key": "skin-DELETE-template"
}
]
}
]
},
"GET": {
"name": "GET",
"all": {
"collection": "skin",
"method": "GET",
"resource": -1,
"description": "All GET resources in the skin REST API collection",
"sensitive_apis": []
},
"resources": [
{
"collection": "skin",
"method": "GET",
"resource": "colors",
"description": "Get color palette for skin",
"sensitive": 0
},
{
"collection": "skin",
"method": "GET",
"resource": "export",
"description": "Export skin",
"sensitive": 0
},
{
"collection": "skin",
"method": "GET",
"resource": "skins",
"description": "Get skins",
"sensitive": 0
},
{
"collection": "skin",
"method": "GET",
"resource": "sections",
"description": "Get template sections",
"sensitive": 0
},
{
"collection": "skin",
"method": "GET",
"resource": "templates",
"description": "Get templates",
"sensitive": 0
},
{
"collection": "skin",
"method": "GET",
"resource": "template",
"description": "Get template",
"sensitive": 0
}
]
},
"PATCH": {
"name": "PATCH",
"all": {
"collection": "skin",
"method": "PATCH",
"resource": -1,
"description": "All PATCH resources in the skin REST API collection",
"sensitive_apis": [
{
"collection": "skin",
"method": "PATCH",
"resource": "skin",
"description": "Edit skin",
"key": "skin-PATCH-skin"
},
{
"collection": "skin",
"method": "PATCH",
"resource": "template",
"description": "Edit template",
"key": "skin-PATCH-template"
}
]
},
"resources": [
{
"collection": "skin",
"method": "PATCH",
"resource": "colors",
"description": "Get color palette for skin",
"sensitive": 0
},
{
"collection": "skin",
"method": "PATCH",
"resource": "flush",
"description": "Flush template cache",
"sensitive": 0
},
{
"collection": "skin",
"method": "PATCH",
"resource": "skin",
"description": "Edit skin",
"sensitive": 1,
"sensitive_apis": [
{
"collection": "skin",
"method": "PATCH",
"resource": "skin",
"description": "Edit skin",
"key": "skin-PATCH-skin"
}
]
},
{
"collection": "skin",
"method": "PATCH",
"resource": "template",
"description": "Edit template",
"sensitive": 1,
"sensitive_apis": [
{
"collection": "skin",
"method": "PATCH",
"resource": "template",
"description": "Edit template",
"key": "skin-PATCH-template"
}
]
}
]
},
"POST": {
"name": "POST",
"all": {
"collection": "skin",
"method": "POST",
"resource": -1,
"description": "All POST resources in the skin REST API collection",
"sensitive_apis": [
{
"collection": "skin",
"method": "POST",
"resource": "import",
"description": "Import backed up skin",
"key": "skin-POST-import"
},
{
"collection": "skin",
"method": "POST",
"resource": "skin",
"description": "Add new skin",
"key": "skin-POST-skin"
},
{
"collection": "skin",
"method": "POST",
"resource": "template",
"description": "Add new template",
"key": "skin-POST-template"
}
]
},
"resources": [
{
"collection": "skin",
"method": "POST",
"resource": "copy-template",
"description": "Copy template",
"sensitive": 0
},
{
"collection": "skin",
"method": "POST",
"resource": "import",
"description": "Import backed up skin",
"sensitive": 1,
"sensitive_apis": [
{
"collection": "skin",
"method": "POST",
"resource": "import",
"description": "Import backed up skin",
"key": "skin-POST-import"
}
]
},
{
"collection": "skin",
"method": "POST",
"resource": "skin",
"description": "Add new skin",
"sensitive": 1,
"sensitive_apis": [
{
"collection": "skin",
"method": "POST",
"resource": "skin",
"description": "Add new skin",
"key": "skin-POST-skin"
}
]
},
{
"collection": "skin",
"method": "POST",
"resource": "template",
"description": "Add new template",
"sensitive": 1,
"sensitive_apis": [
{
"collection": "skin",
"method": "POST",
"resource": "template",
"description": "Add new template",
"key": "skin-POST-template"
}
]
}
]
}
}
}
]
}
}
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(
// Add API parameters here
);
$request = Array(
'method' => 'GET',
'path' => 'v1/affiliate/rest-methods',
'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);
?>
