Difference between revisions of "NATS4 REST API Overview"

From TMM Wiki
Jump to navigationJump to search
Line 364: Line 364:
 
**[[NATS4 REST API Message DELETE permanent|DELETE /message/permanent]]
 
**[[NATS4 REST API Message DELETE permanent|DELETE /message/permanent]]
  
 +
 +
 +
 +
----
 +
'''Notification'''
 +
*'''''GET''''':
 +
**[[NATS4 REST API Notification GET count|GET /notification/count]]
 +
**[[NATS4 REST API Notification GET notifications|GET /notification/notifications]]
 +
**[[NATS4 REST API Notification GET view|GET /notification/view]]
 +
*'''''PATCH''''':
 +
**[[NATS4 REST API Notification PATCH read|PATCH /notification/read]]
 +
**[[NATS4 REST API Notification PATCH unread|PATCH /notification/unread]]
 +
**[[NATS4 REST API Notification PATCH undelete|PATCH /notification/undelete]]
 +
*'''''DELETE''''':
 +
**[[NATS4 REST API Notification DELETE notification|DELETE /notification/notification]]
 +
**[[NATS4 REST API Notification DELETE permanent|DELETE /notification/permanent]]
 +
 +
 +
 +
 +
----
 +
'''Option'''
 +
*'''''GET''''':
 +
**[[NATS4 REST API Get Options|GET /option/options]]
 +
**[[NATS4 REST API Get Option Rule|GET /option/rule]]
 +
*'''''PATCH''''':
 +
**[[NATS4 REST API Edit Option Rule|PATCH /option/rule]]
 +
**[[NATS4 REST API Edit Option Text|PATCH /option/text]]
 +
*'''''POST''''':
 +
**[[NATS4 REST API Add Option Rule|POST /option/rule]]
  
  
Line 369: Line 399:
  
 
----
 
----
 +
'''Payment'''
 +
*'''''GET''''':
 +
**[[NATS4 REST API Payment GET dump-format|GET /payment/dump-format]]
 +
**[[NATS4 REST API Payment GET dump-formats|GET /payment/dump-formats]]
 +
**[[NATS4 REST API Payment GET invoices|GET /payment/invoices]]
 +
**[[NATS4 REST API Get Payment Data|GET /payment/payments]]
 +
**[[NATS4 REST API Payment GET payment-dumps|GET /payment/payment-dumps]]
 +
**[[NATS4 REST API Payment GET payment-dump|GET /payment/payment-dump]]
 +
**[[NATS4 REST API Payment GET payment-search|GET /payment/payment-search]]
 +
**[[NATS4 REST API Payment GET payvia|GET /payment/payvia]]
 +
**[[NATS4 REST API Payment GET payvias|GET /payment/payvias]]
 +
**[[NATS4 REST API Payment GET payvia-fields|GET /payment/payvia-fields]]
 +
**[[NATS4 REST API Payment GET payvia-field-mcs|GET /payment/payvia-field-mcs]]
 +
**[[NATS4 REST API Payment GET payout-period|GET /payment/payout-period]]
 +
**[[NATS4 REST API Payment GET payout-periods|GET /payment/payout-periods]]
 +
**[[NATS4 REST API Payment GET payvia-rules|GET /payment/payvia-rules]]
 +
**[[NATS4 REST API Payment GET payvia-rule|GET /payment/payvia-rule]]
 +
**[[NATS4 REST API Get Payvia Rule|GET /payment/payviarule]]
 +
*'''''POST''''':
 +
**[[NATS4 REST API Payment POST check-dump|POST /payment/check-dump]]
 +
**[[NATS4 REST API Payment POST dump-format|POST /payment/dump-format]]
 +
**[[NATS4 REST API Payment POST import-dump|POST /payment/import-dump]]
 +
**[[NATS4 REST API Payment POST invoice|POST /payment/invoice]]
 +
**[[NATS4 REST API Payment POST payout-period|POST /payment/payout-period]]
 +
**[[NATS4 REST API Payment POST payvia|PATCH /payment/payvia]]
 +
**[[NATS4 REST API Payment POST payvia-field|PATCH /payment/payvia-field]]
 +
**[[NATS4 REST API Payment POST payvia-field-mc|PATCH /payment/payvia-field-mc]]
 +
**[[NATS4 REST API Payment POST payvia-rule|PATCH /payment/payvia-rule]]
 +
*'''''PATCH''''':
 +
**[[NATS4 REST API Payment PATCH copy-dump-format]]
 +
**[[NATS4 REST API Payment PATCH default-payout-period|PATCH /payment/default-payout-period]]
 +
**[[NATS4 REST API Payment PATCH dump-format|PATCH /payment/dump-format]]
 +
**[[NATS4 REST API Payment PATCH duplicate-payvia|PATCH /payment/duplicate-payvia]]
 +
**[[NATS4 REST API Payment PATCH invoice|PATCH /payment/invoice]]
 +
**[[NATS4 REST API Payment PATCH payment|PATCH /payment/payment]]
 +
**[[NATS4 REST API Payment PATCH payment-paid|PATCH /payment/payment-paid]]
 +
**[[NATS4 REST API Payment PATCH payment-store|PATCH /payment/payment-store]]
 +
**[[NATS4 REST API Payment PATCH payment-unstore|PATCH /payment/payment-unstore]]
 +
**[[NATS4 REST API Set Payment Status|PATCH /payment/payments]]
 +
**[[NATS4 REST API Payment PATCH payments-unstore|PATCH /payment/payments-unstore]]
 +
**[[NATS4 REST API Payment PATCH payout-period|PATCH /payment/payout-period]]
 +
**[[NATS4 REST API Payment PATCH payout-period-affiliates|PATCH /payment/payout-period-affiliates]]
 +
**[[NATS4 REST API Payment PATCH payvia|PATCH /payment/payvia]]
 +
**[[NATS4 REST API Payment PATCH payvia-field|PATCH /payment/payvia-field]]
 +
**[[NATS4 REST API Payment PATCH payvia-fields-reorder|PATCH /payment/payvia-fields-reorder]]
 +
**[[NATS4 REST API Payment PATCH payvia-field-mc|PATCH /payment/payvia-field-mc]]
 +
**[[NATS4 REST API Payment PATCH payvia-field-mcs-reorder|PATCH /payment/payvia-field-mcs-reorder]]
 +
**[[NATS4 REST API Payment PATCH payvia-rule|PATCH /payment/payvia-rule]]
 +
**[[NATS4 REST API Set Payvia Rule|PATCH /payment/payviarule]]
 +
**[[NATS4 REST API Payment PATCH restore-payout-period|PATCH /payment/restore-payout-period]]
 +
**[[NATS4 REST API Payment PATCH restore-payvia-field|PATCH /payment/restore-payvia-field]]
 +
**[[NATS4 REST API Payment PATCH restore-payvia-field-mc|PATCH /payment/restore-payvia-field-mc]]
 +
*'''''DELETE''''':
 +
**[[NATS4 REST API Payment DELETE invoice|DELETE /payment/invoice]]
 +
**[[NATS4 REST API Payment DELETE payout-period|DELETE /payment/payout-period]]
 +
**[[NATS4 REST API Payment DELETE payvia-field|DELETE /payment/payvia-field]]
 +
**[[NATS4 REST API Payment DELETE payvia-field-mc|DELETE /payment/payvia-field-mc]]
 +
**[[NATS4 REST API Payment DELETE payvia-rule|DELETE /payment/payvia-rule]]
 +
  
−
'''decodenatscode'''
 
−
*[[NATS4 REST API Decode Natscode|GET /decodenatscode]]
 
  
−
'''member'''
 
−
**'''''actions''''':
 
−
**[[NATS4 REST API Get Member Upsell String|GET /member/upsellstring]]
 
−
**[[NATS4 REST API Get Member Token Rebuy String|GET /member/tokenrebuystring]]
 
−
**[[NATS4 REST API Get Member Instant Upgrade String|GET /member/instantupgradestring]]
 
−
**[[NATS4 REST API Get Member Package Upgrade String|GET /member/packageupgradestring]]
 
−
**[[NATS4 REST API Get Member Details|GET /member/details]]
 
−
**[[NATS4 REST API Get Member Cancel String|GET /member/cancelstring]]
 
−
**[[NATS4 REST API Get Member SignupPlus String|GET /member/signupplusstring]]
 
−
**[[NATS4 REST API Get Member Search Info String|GET /member/searchinfo]]
 
−
**[[NATS4 REST API Add Member Note|POST /member/addnote]]
 
−
**[[NATS4 REST API Record Member Login|POST /member/recordlogin]]
 
−
**[[NATS4 REST API Expire Manual Member|PUT /member/expiremanual]]
 
−
**[[NATS4 REST API Set Member Details|PATCH /member/setdetails]]
 
−
**[[NATS4 REST API Set Member Expiration|PATCH /member/setexpiration]]
 
−
 
−
'''option'''
 
−
**'''''actions''''':
 
−
**[[NATS4 REST API Get Option Rule|GET /option/getrule]]
 
−
**[[NATS4 REST API Add Option Rule|POST /option/addrule]]
 
−
**[[NATS4 REST API Edit Option Text|PUT /option/edittext]]
 
−
**[[NATS4 REST API Edit Option Rule|PATCH /option/editrule]]
 
−
 
−
'''payments'''
 
−
**'''''actions''''':
 
−
**[[NATS4_REST_API_Get_Payment_Data|GET /payments/getpayments]]
 
−
**[[NATS4_REST_API_Set_Payment_Status|PATCH /payments/setstatus]]
 
  
−
'''payviarule'''
 
−
*[[NATS4 REST API Get Payvia Rule|GET /payviarule]]
 
−
*[[NATS4 REST API Set Payvia Rule|PATCH /payviarule]]
 
  
−
'''ping'''
+
----
−
*[[NATS4 REST API Ping| GET /ping]]  
+
'''Program'''
 +
*'''''GET''''':
 +
**[[NATS4 REST API Program GET additional-payout-change-targets|GET /program/additional-payout-change-targets]]
 +
**[[NATS4 REST API Program GET affiliate-available|GET /program/affiliate-available]]
 +
**[[NATS4 REST API Program GET detail|GET /program/detail]]
 +
**[[NATS4 REST API Program GET list|GET /program/list]]
 +
**[[NATS4 REST API Program GET options|GET /program/options]]
 +
**[[NATS4 REST API Program GET payout-changes|GET /program/payout-changes]]
 +
**[[NATS4 REST API Program GET redirect-available|GET /program/redirect-available]]
 +
**[[NATS4 REST API Program GET sites|GET /program/sites]]
 +
**[[NATS4 REST API Program GET tours|GET /program/tours]]
 +
**[[NATS4 REST API Program GET types|GET /program/types]]
 +
*'''''POST''''':
 +
**[[NATS4 REST API Program POST new|POST /program/new]]
 +
**[[NATS4 REST API Program POST payout-change|POST /program/payout-change]]
 +
**[[NATS4 REST API Program POST payout-change-tier|POST /program/payout-change-tier]]
 +
*'''''PATCH''''':
 +
**[[NATS4 REST API Program PATCH default payout|PATCH /program/default_payout]]
 +
**[[NATS4 REST API Program PATCH details|PATCH /program/details]]
 +
**[[NATS4 REST API Program PATCH disable affiliate|PATCH /program/disable_affiliate]]
 +
**[[NATS4 REST API Program PATCH disable tour|PATCH /program/disable_tour]]
 +
**[[NATS4 REST API Program PATCH enable affiliate|PATCH /program/enable_affiliate]]
 +
**[[NATS4 REST API Program PATCH enable site|PATCH /program/enable_site]]
 +
**[[NATS4 REST API Program PATCH enable tour|PATCH /program/enable_tour]]
 +
**[[NATS4 REST API Program PATCH move-payout-change|PATCH /program/move-payout-change]]
 +
**[[NATS4 REST API Program PATCH payout-change|PATCH /program/payout-change]]
 +
**[[NATS4 REST API Program PATCH payout-change-tier|PATCH /program/payout-change-tier]]
 +
*'''''DELETE''''':
 +
**[[NATS4 REST API Program DELETE program|DELETE /program/program]]
 +
**[[NATS4 REST API Program DELETE payout-change|DELETE /program/payout-change]]
 +
**[[NATS4 REST API Program DELETE payout-change-tier|DELETE /program/payout-change-tier]]
  
−
'''profitlossreport'''
 
−
*[[NATS4_REST_API_Get_Profit_Loss_Report|GET /profitlossreport]]
 
  
−
'''sendemail'''
 
−
*[[NATS4 REST API Send Email|POST /sendemail]]
 
  
−
'''suggestedcanceloffers'''
+
 
−
*[[NATS4 REST API Get Suggested Cancel Offers|GET /suggestedcanceloffers]]
+
----
 +
'''Report'''
 +
*'''''GET''''':
 +
**[[NATS4 REST API Report GET affiliate-ratios|GET /report/affiliate-ratios]]
 +
**[[NATS4 REST API Report GET hits|GET /report/hits]]
 +
**[[NATS4 REST API Report GET hit-totals|GET /report/hit-totals]]
 +
**[[NATS4 REST API Get Profit Loss Report|GET /report/profitloss]]
 +
**[[NATS4 REST API Report GET profit-loss|GET /report/profit-loss]]
 +
**[[NATS4 REST API Report GET fields|GET /report/fields]]
 +
**[[NATS4 REST API Report GET focus|GET /report/focus]]
 +
**[[NATS4 REST API Report GET focuses|GET /report/focuses]]
 +
**[[NATS4 REST API Report GET groups|GET /report/groups]]
 +
**[[NATS4 REST API Report GET perspective|GET /report/perspective]]
 +
**[[NATS4 REST API Report GET perspectives|GET /report/perspectives]]
 +
**[[NATS4 REST API Report GET report|GET /report/report]]
 +
**[[NATS4 REST API Report GET subscription|GET /report/subscription]]
 +
**[[NATS4 REST API Report GET surfer|GET /report/surfer]]
 +
**[[NATS4 REST API Report GET surferaction|GET /report/surferaction]]
 +
**[[NATS4 REST API Get Transaction Payout Report|GET /report/transactionpayouts]]
 +
**[[NATS4 REST API Get Transaction Report|GET /report/transactions]]
 +
**[[NATS4 REST API Report GET transaction|GET /report/transaction]]
 +
**[[NATS4 REST API Report GET report-widget|GET /report/report-widget]]
 +
**[[NATS4 REST API Report GET widgets|GET /report/widgets]]
 +
**[[NATS4 REST API Report GET widget|GET /report/widget]]
 +
**[[NATS4 REST API Report GET widget-info|GET /report/widget-info]]
 +
**[[NATS4 REST API Report GET views|GET /report/views]]
 +
*'''''POST''''':
 +
**[[NATS4 REST API Report POST focus|POST /report/focus]]
 +
**[[NATS4 REST API Report POST group|POST /report/group]]
 +
**[[NATS4 REST API Report POST perspective|POST /report/perspective]]
 +
*'''''PATCH''''':
 +
**[[NATS4 REST API Report PATCH focus|PATCH /report/focus]]
 +
**[[NATS4 REST API Report PATCH focus-enabled|PATCH /report/focus-enabled]]
 +
**[[NATS4 REST API Report PATCH focus-default|PATCH /report/focus-default]]
 +
**[[NATS4 REST API Report PATCH focuses-reorder|PATCH /report/focuses-reorder]]
 +
**[[NATS4 REST API Report PATCH perspective|PATCH /report/perspective]]
 +
**[[NATS4 REST API Report PATCH perspective-group|PATCH /report/perspective-group]]
 +
**[[NATS4 REST API Report PATCH report-widget|PATCH /report/report-widget]]
 +
**[[NATS4 REST API Report PATCH widget|PATCH /report/widget]]
 +
*'''''DELETE''''':
 +
**[[NATS4 REST API Report DELETE focus|DELETE /report/focus]]
 +
 
 +
 
 +
 
 +
 
 +
 
 +
----
 +
'''Reward'''
 +
*'''''GET''''':
 +
**[[NATS4 REST API Reward GET categories|GET /reward/categories]]
 +
**[[NATS4 REST API Reward GET points|GET /reward/points]]
 +
**[[NATS4 REST API Reward GET purchases|GET /reward/purchases]]
 +
**[[NATS4 REST API Reward GET rewards|GET /reward/rewards]]
 +
*'''''POST''''':
 +
**[[NATS4 REST API Reward POST category|POST /reward/category]]
 +
**[[NATS4 REST API Reward POST point|POST /reward/point]]
 +
**[[NATS4 REST API Reward POST reward|POST /reward/reward]]
 +
*'''''PATCH''''':
 +
**[[NATS4 REST API Reward PATCH move-point|PATCH /reward/move-point]]
 +
**[[NATS4 REST API Reward PATCH point|PATCH /reward/point]]
 +
**[[NATS4 REST API Reward PATCH reward|PATCH /reward/reward]]
 +
**[[NATS4 REST API Reward PATCH ship-purchase|PATCH /reward/ship-purchase]]
 +
**[[NATS4 REST API Reward PATCH unship-purchase|PATCH /reward/unship-purchase]]
 +
*'''''DELETE''''':
 +
**[[NATS4 REST API Reward DELETE category|DELETE /reward/category]]
 +
**[[NATS4 REST API Reward DELETE purchase|DELETE /reward/purchase]]
 +
**[[NATS4 REST API Reward DELETE point|DELETE /reward/point]]
 +
**[[NATS4 REST API Reward DELETE reward|DELETE /reward/reward]]
 +
 
 +
 
 +
 
 +
 
 +
----
 +
'''Service'''
 +
*'''''GET''''':
 +
**[[NATS4 REST API Service GET check-functions|GET /service/check-functions]]
 +
**[[NATS4 REST API Service GET condition|GET /service/condition]]
 +
**[[NATS4 REST API Service GET countries|GET /service/countries]]
 +
**[[NATS4 REST API Service GET country|GET /service/country]]
 +
**[[NATS4 REST API Service GET datetime|GET /service/datetime]]
 +
**[[NATS4 REST API Service GET languages|GET /service/languages]]
 +
**[[NATS4 REST API Service GET periods|GET /service/periods]]
 +
**[[NATS4 REST API Ping|GET /service/ping]]
 +
**[[NATS4 REST API Service GET project|GET /service/project]]
 +
**[[NATS4 REST API Service GET rule-condition-data|GET /service/rule-condition-data]]
 +
**[[NATS4 REST API Service GET rule-info|GET /service/rule-info]]
 +
**[[NATS4 REST API Service GET stats-breakdowns|GET /service/stats-breakdowns]]
 +
**[[NATS4 REST API Service GET timezone|GET /service/timezone]]
 +
**[[NATS4 REST API Service GET timestamp|GET /service/timestamp]]
 +
*'''''POST''''':
 +
**[[NATS4 REST API Send Email|POST /service/sendemail]]
 +
 
 +
 
 +
 
 +
 
 +
----
 +
'''Site'''
 +
*'''''GET''''':
 +
**[[NATS4 REST API Site GET base-templates|GET /site/base-templates]]
 +
**[[NATS4 REST API Site GET billers|GET /site/billers]]
 +
**[[NATS4 REST API Site GET cookies|GET /site/cookies]]
 +
**[[NATS4 REST API Site GET coupon|GET /site/coupon]]
 +
**[[NATS4 REST API Site GET coupons|GET /site/coupons]]
 +
**[[NATS4 REST API Site GET coupon-revisions|GET /site/coupon-revisions]]
 +
**[[NATS4 REST API Site GET email-settings|GET /site/email-settings]]
 +
**[[NATS4 REST API Site GET groups|GET /site/groups]]
 +
**[[NATS4 REST API Site GET option|GET /site/option]]
 +
**[[NATS4 REST API Site GET options|GET /site/options]]
 +
**[[NATS4 REST API Site GET options-available|GET /site/options-available]]
 +
**[[NATS4 REST API Site GET option-fields|GET /site/option-fields]]
 +
**[[NATS4 REST API Site GET option-rules|GET /site/option-rules]]
 +
**[[NATS4 REST API Site GET option-rule|GET /site/option-rule]]
 +
**[[NATS4 REST API Site GET option-type|GET /site/option-type]]
 +
**[[NATS4 REST API Site GET option-types|GET /site/option-types]]
 +
**[[NATS4 REST API Site GET programs|GET /site/programs]]
 +
**[[NATS4 REST API Site GET site-list|GET /site/site-list]]
 +
**[[NATS4 REST API Site GET site|GET /site/site]]
 +
**[[NATS4 REST API Site GET site-notices|GET /site/site-notices]]
 +
**[[NATS4 REST API Site GET site-partner|GET /site/site-partner]]
 +
**[[NATS4 REST API Site GET site-partners|GET /site/site-partners]]
 +
**[[NATS4 REST API Site GET site-type|GET /site/site-type]]
 +
**[[NATS4 REST API Site GET sites|GET /site/sites]]
 +
**[[NATS4 REST API Site GET template|GET /site/template]]
 +
**[[NATS4 REST API Site GET templates|GET /site/templates]]
 +
**[[NATS4 REST API Site GET template-sections|GET /site/template-sections]]
 +
**[[NATS4 REST API Site GET template-sites|GET /site/template-sites]]
 +
**[[NATS4 REST API Site GET tour|GET /site/tour]]
 +
**[[NATS4 REST API Site GET tours|GET /site/tours]]
 +
**[[NATS4 REST API Site GET tour-emails|GET /site/tour-emails]]
 +
**[[NATS4 REST API Site GET tour-notices|GET /site/tour-notices]]
 +
*'''''POST''''':
 +
**[[NATS4 REST API Site POST coupon|POST /site/coupon]]
 +
**[[NATS4 REST API Site POST group|POST /site/group]]
 +
**[[NATS4 REST API Site POST option|POST /site/option]]
 +
**[[NATS4 REST API Site POST option-rule|POST /site/option-rule]]
 +
**[[NATS4 REST API Site POST site-partner|POST /site/site-partner]]
 +
**[[NATS4 REST API Site POST site-tour|POST /site/site-tour]]
 +
**[[NATS4 REST API Site POST copy-template|POST /site/copy-template]]
 +
**[[NATS4 REST API Site POST tour|POST /site/tour]]
 +
*'''''PATCH''''':
 +
**[[NATS4 REST API Site PATCH cookie|PATCH /site/cookie]]
 +
**[[NATS4 REST API Site PATCH coupon|PATCH /site/coupon]]
 +
**[[NATS4 REST API Site PATCH duplicate-option|PATCH /site/duplicate-option]]
 +
**[[NATS4 REST API Site PATCH email-settings|PATCH /site/email-settings]]
 +
**[[NATS4 REST API Site PATCH group|PATCH /site/group]]
 +
**[[NATS4 REST API Site PATCH move|PATCH /site/move]]
 +
**[[NATS4 REST API Site PATCH option|PATCH /site/option]]
 +
**[[NATS4 REST API Site PATCH option-rule|PATCH /site/option-rule]]
 +
**[[NATS4 REST API Site PATCH reset-coupon|PATCH /site/reset-coupon]]
 +
**[[NATS4 REST API Site PATCH restore-group|PATCH /site/restore-group]]
 +
**[[NATS4 REST API Site PATCH restore-option|PATCH /site/restore-option]]
 +
**[[NATS4 REST API Site PATCH restore-site|PATCH /site/restore-site]]
 +
**[[NATS4 REST API Site PATCH restore-site-partner|PATCH /site/restore-site-partner]]
 +
**[[NATS4 REST API Site PATCH restore-tour|PATCH /site/restore-tour]]
 +
**[[NATS4 REST API Site PATCH site|PATCH /site/site]]
 +
**[[NATS4 REST API Site PATCH site-partner|PATCH /site/site-partner]]
 +
**[[NATS4 REST API Site PATCH template|PATCH /site/template]]
 +
**[[NATS4 REST API Site PATCH tour|PATCH /site/tour]]
 +
*'''''DELETE''''':
 +
**[[NATS4 REST API Site DELETE cookie|DELETE /site/cookie]]
 +
**[[NATS4 REST API Site DELETE group|DELETE /site/group]]
 +
**[[NATS4 REST API Site DELETE option|DELETE /site/option]]
 +
**[[NATS4 REST API Site DELETE option-rule|DELETE /site/option-rule]]
 +
**[[NATS4 REST API Site DELETE site|DELETE /site/site]]
 +
**[[NATS4 REST API Site DELETE site-partner|DELETE /site/site-partner]]
 +
**[[NATS4 REST API Site DELETE template|DELETE /site/template]]
 +
**[[NATS4 REST API Site DELETE tour|DELETE /site/tour]]
 +
**[[NATS4 REST API Site DELETE tour-field|DELETE /site/tour-field]]
 +
 
 +
 
 +
 
 +
 
 +
 
 +
----
 +
'''Skin'''
 +
*'''''GET''''':
 +
**[[NATS4 REST API Skin GET colors|GET /skin/colors]]
 +
**[[NATS4 REST API Skin GET export|GET /skin/export]]
 +
**[[NATS4 REST API Skin GET skins|GET /skin/skins]]
 +
**[[NATS4 REST API Skin GET sections|GET /skin/sections]]
 +
**[[NATS4 REST API Skin GET templates|GET /skin/templates]]
 +
**[[NATS4 REST API Skin GET template|GET /skin/template]]
 +
*'''''POST''''':
 +
**[[NATS4 REST API Skin POST copy-template|POST /skin/copy-template]]
 +
**[[NATS4 REST API Skin POST import|POST /skin/import]]
 +
**[[NATS4 REST API Skin POST skin|POST /skin/skin]]
 +
**[[NATS4 REST API Skin POST template|POST /skin/template]]
 +
*'''''PATCH''''':
 +
**[[NATS4 REST API Skin PATCH colors|PATCH /skin/colors]]
 +
**[[NATS4 REST API Skin PATCH flush|PATCH /skin/flush]]
 +
**[[NATS4 REST API Skin PATCH skin|PATCH /skin/skin]]
 +
**[[NATS4 REST API Skin PATCH template|PATCH /skin/template]]
 +
*'''''DELETE''''':
 +
**[[NATS4 REST API Skin DELETE skin|DELETE /skin/skin]]
 +
**[[NATS4 REST API Skin DELETE template|DELETE /skin/template]]
  
 
== Gaining Access to the REST  API ==  
 
== Gaining Access to the REST  API ==  

Revision as of 11:30, 5 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


Mailing


Maintenance


Member


Message



Notification



Option



Payment



Program



Report



Reward



Service



Site



Skin

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=26331"