Difference between revisions of "NATS4 REST API Overview"

From TMM Wiki
Jump to navigationJump to search
Line 16: Line 16:
 
== Allowed Endpoints ==
 
== Allowed Endpoints ==
  
−
'''adtools'''
+
'''Adtool'''
−
**'''''actions''''':
+
*'''''GET''''':
−
**[[NATS4 REST API Adtool Types|GET /adtools/types]]  
+
**[[NATS4 REST API Admin Get Adtools|GET /adtool/admin]]
−
**[[NATS4 REST API Adtool Categories|GET /adtools/categories]]  
+
**[[NATS4 REST API Adtool GET adtools|GET /adtool/adtools]]
−
**[[NATS4 REST API Admin Get Adtools|GET /adtools/admin]]  
+
**[[NATS4 REST API Adtool GET adtool|GET /adtool/adtool]]
−
**[[NATS4 REST API Bulk Import Adtools|POST /adtools/importdump]]  
+
**[[NATS4 REST API Adtool GET adtool-rules|GET /adtool/adtool-rules]]
 +
**[[NATS4 REST API Adtool GET adtool-rule|GET /adtool/adtool-rule]]
 +
**[[NATS4 REST API Adtool Categories|GET /adtool/categories]]  
 +
**[[NATS4 REST API Adtool GET field-options|GET /adtool/field-options]]
 +
**[[NATS4 REST API Adtool GET field-types|GET /adtool/field-types]]
 +
**[[NATS4 REST API Adtool GET groups|GET /adtool/groups]]
 +
**[[NATS4 REST API Adtool GET search|GET /adtool/search]]
 +
**[[NATS4 REST API Adtool GET templates|GET /adtool/templates]]
 +
**[[NATS4 REST API Adtool Types|GET /adtool/types]]
 +
**[[NATS4 REST API Adtool GET type|GET /adtool/type]]
 +
*'''''POST''''':
 +
**[[NATS4 REST API Adtool POST adtool|POST /adtool/adtool]]
 +
**[[NATS4 REST API Adtool POST adtool-rule|POST /adtool/adtool-rule]]
 +
**[[NATS4 REST API Adtool POST category|POST /adtool/category]]
 +
**[[NATS4 REST API Adtool POST field|POST /adtool/field]]
 +
**[[NATS4 REST API Adtool POST field-option|POST /adtool/field-option]]
 +
**[[NATS4 REST API Adtool POST group|POST /adtool/group]]
 +
**[[NATS4 REST API Bulk Import Adtools|POST /adtool/import]]
 +
**[[NATS4 REST API Adtool POST type|POST /adtool/type]]
 +
*'''''PATCH''''':
 +
**[[NATS4 REST API Adtool PATCH adtool|PATCH adtool/adtool]]
 +
**[[NATS4 REST API Adtool PATCH adtool-group|PATCH /adtool/adtool-group]]
 +
**[[NATS4 REST API Adtool PATCH adtool-rule|PATCH /adtool/adtool-rule]]
 +
**[[NATS4 REST API Adtool PATCH category|PATCH /adtool/category]]
 +
**[[NATS4 REST API Adtool PATCH field|PATCH /adtool/field]]
 +
**[[NATS4 REST API Adtool PATCH field-option|PATCH /adtool/field-option]]
 +
**[[NATS4 REST API Adtool PATCH group|PATCH /adtool/group]]
 +
**[[NATS4 REST API Adtool PATCH move|PATCH /adtool/move]]
 +
**[[NATS4 REST API Adtool PATCH restore-adtool|PATCH /adtool/restore-adtool]]
 +
**[[NATS4 REST API Adtool PATCH restore-category|PATCH /adtool/restore-category]]
 +
**[[NATS4 REST API Adtool PATCH restore-field|PATCH /adtool/restore-field]]
 +
**[[NATS4 REST API Adtool PATCH restore-field-option|PATCH /adtool/restore-field-option]]
 +
**[[NATS4 REST API Adtool PATCH restore-type|PATCH /adtool/restore-type]]
 +
**[[NATS4 REST API Adtool PATCH type|PATCH /adtool/type]]
 +
*'''''DELETE''''':
 +
**[[NATS4 REST API Adtool DELETE adtool|DELETE /adtool/adtool]]
 +
**[[NATS4 REST API Adtool DELETE adtool-rule|DELETE /adtool/adtool-rule]]
 +
**[[NATS4 REST API Adtool DELETE category|DELETE /adtool/category]]
 +
**[[NATS4 REST API Adtool DELETE field|DELETE /adtool/field]]
 +
**[[NATS4 REST API Adtool DELETE field-option|DELETE /adtool/field-option]]
 +
**[[NATS4 REST API Adtool DELETE group|DELETE /adtool/group]]
 +
**[[NATS4 REST API Adtool DELETE type|DELETE /adtool/type]]
  
−
'''affiliate'''
+
 
−
**'''''actions''''':
+
----
−
**[[NATS4_REST_API_Get_Affiliate_Hit_Data|GET /affiliate/hitdata]]  
+
 
 +
'''Affiliate'''
 +
*'''''GET''''':
 +
**[[NATS4 REST API Affiliate GET account-changes|GET /affiliate/account-changes]]
 +
**[[NATS4 REST API Affiliate GET account-types|GET /affiliate/account-types]]
 +
**[[NATS4 REST API Affiliate GET admin-settings|GET /affiliate/admin-settings]]
 
**[[NATS4 REST API Affiliate Get Campaigns|GET /affiliate/campaigns]]  
 
**[[NATS4 REST API Affiliate Get Campaigns|GET /affiliate/campaigns]]  
−
**[[NATS4_REST_API_Get_Affiliate_Payout|GET /affiliate/payout]]  
+
**[[NATS4 REST API Affiliate GET current|GET /affiliate/current]]
−
**[[NATS4 REST API Search Affiliate Info|GET /affiliate/searchinfo]]  
+
**[[NATS4 REST API Affiliate GET current-permissions|GET /affiliate/current-permissions]]
−
**[[NATS4 REST API Add Affiliate|POST /affiliate/addaffiliate]]  
+
**[[NATS4 REST API Affiliate GET docs|GET /affiliate/docs]]
−
**[[NATS4 REST API Set Affiliate Customs|PATCH /affiliate/setcustoms]]  
+
**[[NATS4 REST API Affiliate GET doc|GET /affiliate/doc]]
−
**[[NATS4 REST API Set Affiliate Information|PATCH /affiliate/setinformation]]  
+
**[[NATS4 REST API Affiliate GET groups|GET /affiliate/groups]]
−
**[[NATS4 REST API Set Affiliate Admin Settings|PATCH /affiliate/setadminsettings]]  
+
**[[NATS4 REST API Affiliate GET group|GET /affiliate/group]]
−
**[[NATS4 REST API Set Affiliate Payvia Info|PATCH /affiliate/setpayviainfo]]
+
**[[NATS4 REST API Get Affiliate Hit Data|GET /affiliate/hits]]
−
**[[NATS4 REST API Set Affiliate Defaults|PATCH /affiliate/setdefaults]]
+
**[[NATS4 REST API Affiliate GET link-styles|GET /affiliate/link-styles]]
−
**[[NATS4 REST API Set Affiliate Settings|PATCH /affiliate/setsettings]]  
+
**[[NATS4 REST API Affiliate GET loginids|GET /affiliate/loginids]]
 +
**[[NATS4 REST API Affiliate GET loginlog|GET /affiliate/loginlog]]
 +
**[[NATS4 REST API Affiliate GET manual-payout|GET /affiliate/manual-payout]]
 +
**[[NATS4 REST API Affiliate GET news-sections|GET /affiliate/news-sections]]
 +
**[[NATS4 REST API Affiliate GET notes|GET /affiliate/notes]]
 +
**[[NATS4 REST API Affiliate GET notices|GET /affiliate/notices]]
 +
**[[NATS4 REST API Affiliate GET override|GET /affiliate/override]]
 +
**[[NATS4 REST API Get Affiliate Payout|GET /affiliate/payout]] 
 +
**[[NATS4 REST API Affiliate GET payment-periods|GET /affiliate/payment-periods]]
 +
**[[NATS4 REST API Affiliate GET payvia-types|GET /affiliate/payvia-types]]
 +
**[[NATS4 REST API Affiliate GET payvia-type|GET /affiliate/payvia-type]]
 +
**[[NATS4 REST API Affiliate GET permissions|GET /affiliate/permissions]]
 +
**[[NATS4 REST API Affiliate GET programcampaigns|GET /affiliate/programcampaigns]]
 +
**[[NATS4 REST API Affiliate GET referrer|GET /affiliate/referrer]]
 +
**[[NATS4 REST API Affiliate GET referring-urls|GET /affiliate/referring-urls]]
 +
**[[NATS4 REST API Affiliate GET reps|GET /affiliate/reps]]
 +
**[[NATS4 REST API Affiliate GET rest-methods|GET /affiliate/rest-methods]]
 +
**[[NATS4 REST API Affiliate GET search|GET /affiliate/search]]
 +
**[[NATS4 REST API Affiliate GET settings|GET /affiliate/settings]]
 +
**[[NATS4 REST API Affiliate GET skins|GET /affiliate/skins]]
 +
**[[NATS4 REST API Affiliate GET soap-functions|GET /affiliate/soap-functions]]
 +
**[[NATS4 REST API Affiliate GET status|GET /affiliate/status]]
 +
*'''''POST''''':
 +
**[[NATS4 REST API Affiliate POST account-type|POST /affiliate/account-type]]
 +
**[[NATS4 REST API Add Affiliate|POST /affiliate/add]]
 +
**[[NATS4 REST API Affiliate POST doc|POST /affiliate/doc]]
 +
**[[NATS4 REST API Affiliate POST group|POST /affiliate/group]]
 +
**[[NATS4 REST API Add Affiliate Manual Invoice|POST /affiliate/invoice]]
 +
**[[NATS4 REST API Affiliate POST manual-sale|POST /affiliate/manual-sale]]
 +
**[[NATS4 REST API Affiliate POST note|POST /affiliate/note]]
 +
*'''''PATCH''''':
 +
**[[NATS4 REST API Affiliate PATCH adminsettings|PATCH /affiliate/adminsettings]]
 +
**[[NATS4 REST API Affiliate PATCH account-change|PATCH /affiliate/account-change]]
 +
**[[NATS4 REST API Affiliate PATCH account-type|PATCH /affiliate/account-type]]
 +
**[[NATS4 REST API Affiliate PATCH account-type-permissions|PATCH /affiliate/account-type-permissions]]
 +
**[[NATS4 REST API Affiliate PATCH admin-setting|PATCH /affiliate/admin-setting]]
 +
**[[NATS4 REST API Affiliate PATCH affiliate-account-type|PATCH /affiliate/affiliate-account-type]]
 +
**[[NATS4 REST API Affiliate PATCH affiliate-group|PATCH /affiliate/affiliate-group]]
 +
**[[NATS4 REST API Affiliate PATCH allsettings|PATCH /affiliate/allsettings]]
 +
**[[NATS4 REST API Affiliate PATCH account-rep|PATCH /affiliate/account-rep]]
 +
**[[NATS4 REST API Affiliate PATCH avatar|PATCH /affiliate/avatar]]
 +
**[[NATS4 REST API Set Affiliate Customs|PATCH /affiliate/customs]]
 +
**[[NATS4 REST API Set Affiliate Defaults|PATCH /affiliate/defaults]]
 +
**[[NATS4 REST API Set Affiliate Information|PATCH /affiliate/details]]
 +
**[[NATS4 REST API Affiliate PATCH override|PATCH /affiliate/override]]
 +
**[[NATS4 REST API Affiliate PATCH password|PATCH /affiliate/password]]
 +
**[[NATS4 REST API Affiliate PATCH payment-period|PATCH /affiliate/payment-period]]
 +
**[[NATS4 REST API Affiliate PATCH payvia|PATCH /affiliate/payvia]]
 +
**[[NATS4 REST API Set Affiliate Payvia Info|PATCH /affiliate/payvia-info]]
 +
**[[NATS4 REST API Affiliate PATCH permissions|PATCH /affiliate/permissions]]
 +
**[[NATS4 REST API Affiliate PATCH referrer|PATCH /affiliate/referrer]]
 +
**[[NATS4 REST API Affiliate PATCH reset-api|PATCH /affiliate/reset-api]]
 +
**[[NATS4 REST API Affiliate PATCH reset-rss|PATCH /affiliate/reset-rss]]
 +
**[[NATS4 REST API Affiliate PATCH reset-tos|PATCH /affiliate/reset-tos]]
 +
**[[NATS4 REST API Affiliate PATCH rest-permissions|PATCH /affiliate/reset-permissions]]
 +
**[[NATS4 REST API Affiliate PATCH restore|PATCH /affiliate/restore]]
 +
**[[NATS4 REST API Affiliate PATCH restore-account-type|PATCH /affiliate/restore-account-type]]
 +
**[[NATS4 REST API Set Affiliate Settings|PATCH /affiliate/settings]]
 +
**[[NATS4 REST API Affiliate PATCH soap-permissions|PATCH /affiliate/soap-permissions]]
 +
**[[NATS4 REST API Set Affiliate Status|PATCH /affiliate/status]]
 +
*'''''DELETE''''':
 +
**[[NATS4 REST API Affiliate DELETE account-rep|DELETE /affiliate/account-rep]]
 +
**[[NATS4 REST API Affiliate DELETE account-type|DELETE /affiliate/account-type]]
 +
**[[NATS4 REST API Affiliate DELETE affiliate|DELETE /affiliate/affiliate]]
 +
**[[NATS4 REST API Affiliate DELETE doc|DELETE /affiliate/doc]]
 +
**[[NATS4 REST API Affiliate DELETE group|DELETE /affiliate/group]]
 +
**[[NATS4 REST API Affiliate DELETE permissions|DELETE /affiliate/permissions]]
 +
 
 +
 
 +
 
 +
----
 +
 
 +
'''Biller'''
 +
*'''''GET'''''
 +
**[[NATS4 REST API Biller GET available|GET /biller/available]]
 +
**[[NATS4 REST API Biller GET partner-available|GET /biller/partner-available]]
 +
**[[NATS4 REST API Biller GET billerdata|GET /biller/billerdata]]
 +
**[[NATS4 REST API Biller GET cascades|GET /biller/cascades]]
 +
**[[NATS4 REST API Biller GET cascades-available|GET /biller/cascades-available]]
 +
**[[NATS4 REST API Biller GET cascade-count|GET /biller/cascade-count]]
 +
**[[NATS4 REST API Biller GET cascade-history|GET /biller/cascade-history]]
 +
**[[NATS4 REST API Biller GET cascade-rules|GET /biller/cascade-rules]]
 +
**[[NATS4 REST API Biller GET cascade-rule|GET /biller/cascade-rule]]
 +
**[[NATS4 REST API Biller GET cascade-step-count|GET /biller/cascade-step-count]]
 +
**[[NATS4 REST API Biller GET cascade-steps|GET /biller/cascade-steps]]
 +
**[[NATS4 REST API Biller GET cascade-detail|GET /biller/cascade-detail]]
 +
**[[NATS4 REST API Biller GET cascade-list|GET /biller/cascade-list]]
 +
**[[NATS4 REST API Biller GET count|GET /biller/count]]
 +
**[[NATS4 REST API Biller GET detail|GET /biller/detail]]
 +
**[[NATS4 REST API Biller GET fees|GET /biller/fees]]
 +
**[[NATS4 REST API Biller GET partner-fees|GET /biller/partner-fees]]
 +
**[[NATS4 REST API Biller GET last poll|GET /biller/last_poll]]
 +
**[[NATS4 REST API Biller GET partner-last-poll|GET /biller/partner-last-poll]]
 +
**[[NATS4 REST API Biller GET list|GET /biller/list]]
 +
**[[NATS4 REST API Biller GET partner-detail|GET /biller/partner-detail]]
 +
**[[NATS4 REST API Biller GET partner-list|GET /biller/partner-list]]
 +
**[[NATS4 REST API Biller GET partner-shortnames|GET /biller/partner-shortnames]]
 +
**[[NATS4 REST API Biller GET process types|GET /biller/process_types]]
 +
**[[NATS4 REST API Biller GET partner-process-types|GET /biller/partner-process-types]]
 +
**[[NATS4 REST API Biller GET shortnames|GET /biller/shortnames]]
 +
**[[NATS4 REST API Biller GET transaction types|GET /biller/transaction_types]]
 +
**[[NATS4 REST API Biller GET partner-transaction-types|GET /biller/partner-transaction-types]]
 +
**[[NATS4 REST API Biller GET taxes|GET /biller/taxes]]
 +
*'''''POST''''':
 +
**[[NATS4 REST API Biller POST add|POST /biller/add]]
 +
**[[NATS4 REST API Biller POST cascade|POST /biller/cascade]]
 +
**[[NATS4 REST API Biller POST cascade-rule|POST /biller/cascade-rule]]
 +
**[[NATS4 REST API Biller POST cascade-step|POST /biller/cascade-step]]
 +
**[[NATS4 REST API Biller POST partner|POST /biller/partner]]
 +
*'''''PATCH''''':
 +
**[[NATS4 REST API Biller PATCH cascade|PATCH /biller/cascade]]
 +
**[[NATS4 REST API Biller PATCH cascade-rule|PATCH /biller/cascade-rule]]
 +
**[[NATS4 REST API Biller PATCH cascade-step|PATCH /biller/cascade-step]]
 +
**[[NATS4 REST API Biller PATCH cascade-steps-reorder|PATCH /biller/cascade-steps-reorder]]
 +
**[[NATS4 REST API Biller PATCH fee|PATCH /biller/fee]]
 +
**[[NATS4 REST API Biller PATCH partner-fee|PATCH /biller/partner-fee]]
 +
**[[NATS4 REST API Biller PATCH restore|PATCH /biller/restore]]
 +
**[[NATS4 REST API Biller PATCH restore-cascade|PATCH /biller/restore-cascade]]
 +
**[[NATS4 REST API Biller PATCH restore-partner|PATCH /biller/restore-partner]]
 +
**[[NATS4 REST API Biller PATCH setting|PATCH /biller/setting]]
 +
**[[NATS4 REST API Biller PATCH partner-setting|PATCH /biller/partner-setting]]
 +
**[[NATS4 REST API Biller PATCH tax|PATCH /biller/tax]]
 +
*'''''DELETE''''':
 +
**[[NATS4 REST API Biller DELETE biller|DELETE /biller/biller]]
 +
**[[NATS4 REST API Biller DELETE cascade|DELETE /biller/cascade]]
 +
**[[NATS4 REST API Biller DELETE cascade-rule|DELETE /biller/cascade-rule]]
 +
**[[NATS4 REST API Biller DELETE cascade-step|DELETE /biller/cascade-step]]
 +
**[[NATS4 REST API Biller DELETE fee|DELETE /biller/fee]]
 +
**[[NATS4 REST API Biller DELETE partner-fee|DELETE /biller/partner-fee]]
 +
**[[NATS4 REST API Biller DELETE partner|DELETE /biller/partner]]
 +
**[[NATS4 REST API Biller DELETE tax|DELETE /biller/tax]]
 +
 
 +
 
 +
----
 +
 
 +
'''Codes'''
 +
*'''''GET''''':
 +
**[[NATS4 REST API Codes GET affiliate-codes|GET /codes/affiliate-codes]]
 +
**[[NATS4 REST API Decode Natscode|GET /codes/decode]]
 +
**[[NATS4 REST API Codes GET linkcodes|GET /codes/linkcodes]]
 +
**[[NATS4 REST API Codes GET strack|GET /codes/strack]]
 +
 
 +
 
 +
 
 +
----
 +
 
 +
'''Config'''
 +
*'''''GET''''':
 +
**[[NATS4 REST API Config GET section|GET /config/section]]
 +
**[[NATS4 REST API Config GET sections|GET /config/sections]]
 +
*'''''PATCH''''':
 +
**[[NATS4 REST API Config PATCH affiliate default|PATCH /config/affiliate_default]]
 +
**[[NATS4 REST API Config PATCH section|PATCH /config/seciton]]
 +
*'''''DELETE''''':
 +
**[[NATS4 REST API Config DELETE setting|DELETE /config/setting]]
 +
 
 +
 
 +
----
 +
 
 +
'''Include'''
 +
*'''''GET''''':
 +
**[[NATS4 REST API Include GET include|GET /include/include]]
 +
**[[NATS4 REST API Include GET includes|GET /include/includes]]
 +
**[[NATS4 REST API Include GET templates|GET /include/templates]]
 +
*'''''POST''''':
 +
**[[NATS4 REST API Include POST include|POST /include/include]]
 +
**[[NATS4 REST API Include POST step|POST /include/step]]
 +
*'''''PATCH''''':
 +
**[[NATS4 REST API Include PATCH include|PATCH /include/include]]
 +
**[[NATS4 REST API Include PATCH restore|PATCH /include/restore]]
 +
**[[NATS4 REST API Include PATCH step|PATCH /include/step]]
 +
*'''''DELETE''''':
 +
**[[NATS4 REST API Include DELETE include|DELETE /include/include]]
 +
**[[NATS4 REST API Include DELETE step|DELETE /include/step]]
 +
 
 +
 
 +
 
 +
----
 +
 
 +
 
 +
 
 +
 
 +
 
 +
----
  
 
'''decodenatscode'''
 
'''decodenatscode'''

Revision as of 15:41, 2 August 2019

NATS 4
Members Admin
The Members Admin
View Member Details
Add Member
MySQL Auth
Mod Authn DB
Multisite Access
Member Logging
Member Password Retrieval
OpenID Connect
Mod Auth OpenIDC
ID Numbers
SOAP API
API
API Best Practices
WSDL Cache
Add Affiliate
Add Member Note
Admin Get Adtools
Adtool Categories
Adtool Types
Affiliate Get Campaigns
Bulk Import Adtools
Caching
Decode Natscode
Expire Manual Member
Get Affiliate Campaigns
Get Affiliate Hit Data
Get Affiliate Loginids
Get Affiliate Nats Codes
Get Affiliate Payout
Get Affiliate Program Campaign List
Get_Affiliate_Program_Campaign_List
Get Member Details
Get Member Instant Upgrade String
Get Member Package Upgrade String
Get Member Token Rebuy String
Get Member Upsell String
Get Payment Data
Get Payvia Rule
Get Profit Loss Report
Ping
Record Member Login
Search Affiliate Info
Search Member Info
Send Email API Function
Set Affiliate Admin Settings
Set Affiliate Customs
Set Affiliate Defaults
Set Affiliate Information
Set Affiliate Settings
Set Member Details
Set Payment Status
Set Payvia Rule
REST API
API Overview
API Best Practices
REST API PATH UPDATES
Adtools
GET /adtools/admin
GET /adtools/categories
GET /adtools/types
POST /adtools/importdump
Affiliate
GET /affiliate/campaigns
GET /affiliate/hitdata
GET /affiliate/payout
GET /affiliate/searchinfo
POST /affiliate/addaffiliate
POST /affiliate/invoice
PATCH /affiliate/setadminsettings
PATCH /affiliate/setcustoms
PATCH /affiliate/setdefaults
PATCH /affiliate/setinformation
PATCH /affiliate/setpayviainfo
PATCH /affiliate/setsettings
PATCH /affiliate/status
Member
GET /member/authstring
GET /member/details
GET /member/searchinfo
GET /suggestedcanceloffers
PATCH /member/setdetails
PATCH /member/setexpiration
POST /member/addnote
POST /member/recordlogin
PUT /member/expiremanual
PATCH /member/forget
Option
GET /option/options
GET /option/rule
PATCH /option/rule
PATCH/option/text
POST /option/rule
Payments
GET /payments/getpayments
GET /payviarule
PATCH /payments/setstatus
PATCH /payviarule
Report
GET /profitlossreport
Get /transactionpayouts
GET /report/transaction
Service
GET /service/decodenatscode
GET /service/ping
POST /service/sendemail

NOTE

Currently the NATS REST API is in the process of being updated which includes changes to how data is being passed to and from the API itself. We will update this Article when this update is complete to let you know which version to upgrade to. If you would like to use the current NATS REST API, please submit a support ticket and a tech will add the additional feature to your install. Please understand that the system itself will change during the course of this update

Overview

The NATS REST API is accessible at http://<domain>/api/<endpoint>/<action>

  • The API is accessible to admins. /api/<endpoint>/<action> is available only to admins.
  • Replace <domain> with your NATS install domain name.
  • Replace <endpoint> with the endpoint that you are trying to access
  • Some of the endpoints do not require <action> in the url and all of the urls will be specified in the documentation

Allowed Endpoints

Adtool


Affiliate


Biller


Codes


Config


Include




decodenatscode

member

option

payments

payviarule

ping

profitlossreport

sendemail

suggestedcanceloffers

Gaining Access to the REST API

In order to access NATS API your IP address must be in the ADMIN_API_ALLOWED_IPS list. You can add or remove IP addresses to this list via the Configurations Admin under the "Security" tab.

Allowed HTTP Request Methods

  • GET
  • POST
  • PUT (if PUT requests are not honored, please add 'x-http-method: PUT' in the headers array passed)
  • PATCH (if PATCH requests are not honored, please add 'x-http-method: PATCH' in the headers array passed)

Response Format

Response Status Codes

200

  • On Success, the API will return a '200' status and output the results of the API call. Please refer to the available API endpoints for possible responses.
  • NOTE: As long as the endpoint and HTTP request method are valid and there are no invalid parameters, a '200' response is returned.

400

  • The API will return a '400' status if an invalid or unsupported HTTP request is sent.

404

  • The API will return either a '404' status if an invalid parameter is sent, or if an HTTP request is sent to an invalid endpoint.

405

  • The API will return a '405' status if an invalid HTTP request method is used.

Authentication

  • The NATS REST API uses HTTP Header Authentication.
  • Each REST API request requires the Affiliate username and the Affiliate API key to be sent with the HTTP headers of the request.
  • To retrieve your API key simply select it from the login table of your NATS database or put in a support ticket and we can retrieve it for you.
  • If you do not have an API key, you can set one by going to the Affiliates Admin and clicking the icon labeled, "Change API Key".
  • Please note that only full admin accounts are authorized to use the API and set an API key.

Required HTTP Headers

  • api-key: Affiliate api key
  • api-username: Affiliate user name
    • NOTE** The headers keys are NOT case sensitive.

Example Authentication

Authentication can be handled in various ways using different programming languages. Below are some complete example calls to the Ping endpoint with HTTP Header authentication.

PHP 

<?php 
$url = 'http://domain/api/service/ping';
$curl = curl_init(); 
 
$headers = array( 
    'api-key: 44b5498dbcb481a0d00b404c0169af62', 
    'api-username: tmm1phrvezsbu' 
); 
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); 
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); 
curl_setopt($curl, CURLOPT_URL, $url); 
                                                                                                                                                               
$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); 
?>

Python

  • This example requires pip and the request library which can be installed via pip by: 'pip install requests'
import requests

url = 'http://domain/api/service/ping'
headers = {
	'api-key': '44b5498dbcb481a0d00b404c0169af62',
	'api-username': 'tmm1phrvezsbu'
}
 params =  { 
        'payvia_type_id': 1, 
        'rule_type': 'enabled' 
 }
	
res = requests.get(url, params=params, headers=headers)
print res.json()

node.js

  • This example requires npm and the request module which can be installed via npm by: 'npm install request'
var request = require('request');
                          
var options = {           
    url: 'http://domain/api/service/ping',
    method: 'GET',        
    json: true,           
    headers: {            
        'api-key': '44b5498dbcb481a0d00b404c0169af62',
        'api-username': 'tmm1phrvezsbu'
    }                     
};                        
                          
function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }                     
    else{                 
        console.log(body);                                                                                                                                     
    }                     
                          
}                         
                          
request(options, callback);

Curl 

curl -X GET 'http://domain/api/service/ping' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu"

And this is the output: 

true
Retrieved from "https://tmmwiki.com/index.php?title=NATS4_REST_API_Overview&oldid=26328"