NATS For Networks REST Add Commission Change

From TMM Wiki
Jump to: navigation, search
NATS For Networks
For Affiliates
Automatic SubIDs
Affiliate Stats Dumps
Linkcode
Affiliate Custom Pixels
Affiliate Host and Post
Affiliate Area
Affiliate Account Details
Affiliate Account Change Log
Affiliate Creatives
Affiliate Creatives Search
Affiliate Settings
Affiliate Custom Pixels
Affiliate Linkcodes
Affiliate Linkcode Settings
Affiliate Login History
Affiliate Messages
Affiliate Dashboard
Dashboard Key Statistics
Dashboard Statistics Summary
Affiliate Payment History
Quick Links
Affiliate Referrals Report
Affiliate Referring URL Report
Affiliate Remote Login
Affiliate Signup
Affiliate Statistic Filters
Affiliate Statistic Views
Affiliate SubIDs
NATS For Networks Setup
Creating Admin Accounts
Tracking Domain
Edit Affiliate Text
Edit CSS Colors
Getting Started Admin
Quick Start Guide
Tracking in NATS For Networks
Pixel Builder
Postback Examples
Replacement Variables
Currency Exchange Rates

Admin Dashboard
The Admin Dashboard
Reporting Admin
The Reporting Admin
Track and Strack
  Report Breakdowns
Profit and Loss Report
Subscription Report
Transactions Reports
Affiliate Ratios Report
Affiliate Managers Report
Referral Tier Payouts Report
Referral Signup Payouts Report
Additional Commissions Report
Graphical Affiliate Comparison Report
The Single Day Comparison Report
Actual Affiliate Payments Report
Offers Admin
The Offers Admin
Offers
Offer Setup
Affiliate Referrals
Tracking Domain
Commissions
Commission Changes
Suppression Lists
Pixel Builder
ID Numbers
Offer Partner
Offer/Landing Page Redirection
Setting Rules
Admin Host and Post
Offer Goals
Affiliates Admin
The Affiliates Admin
ID Numbers
Affiliate Managers
Affiliate Referrals
Affiliate Activation
Admin-Only Settings
Affiliate Overrides
Creating Admin Accounts
In-House Accounts
Add Manual Sale
Manual Invoice
Affiliate Documents
Affiliate Enabled Offers
Change Affiliate Status
Account Changes
Advertisers Admin
The Advertisers Admin
Account Changes
Advertiser Invoices
Generate Invoice
Advertiser Approval
Change Advertiser Status
Customers Admin
Customers Admin
Manually Adding a Customer
ID Numbers
Payments Admin
The Payments Admin
Payvia Types
Payout Periods
Payvia Dump Formats
Payment Dump Entry Numbers
Payment Dump Variables
Check Functions
Setting Rules
Payment Methods
Payza
REST API
General
API Overview
GET /service/ping
GET /service/set_currency_exchange_rates
Advertiser
POST /advertiser/add_advertiser
PATCH /advertiser/edit_advertiser
Affiliate
GET /affiliate/get_links
GET /affiliate/get_single_link
GET /affiliate/search
GET /affiliate/decode_trackingcode
PATCH /affiliate/edit_affiliate
POST /affiliate/add_affiliate
POST /affiliate/affiliate_login_ips
Creative
GET /creative/get_creatives
GET /creative/get_creative_fields
GET /creative/get_creative_rules
PATCH /creative/delete_creative
PATCH /creative/edit_creative
PATCH /creative/edit_creative_rules
PATCH /creative/undelete_creative
POST /creative/add_creative
POST /creative/add_creative_rule
POST /creative/delete_creative_rules
Offer
GET /offer/check_orderid_exists
GET /offer/get_commission_changes
GET /offer/get_conversion_caps
PATCH /offer/activate_offer
PATCH /offer/edit_landing_page
PATCH /offer/edit_offer
PATCH /offer/pause_offer
PATCH /offer/set_commission_change_payouts
PATCH /offer/set_enabled_affiliates
PATCH /offer/set_offer_categories
PATCH /offer/set_offer_countries
PATCH /offer/set_offer_goals
PATCH /offer/set_offer_groups
PATCH /offer/set_offer_marketing_types
PATCH /offer/store_offer_ips
POST /offer/add_commission_change
POST /offer/add_landing_page
POST /offer/add_offer
POST /offer/add_tracking_domain
Reporting
GET /report/profitloss
GET /report/transaction
Customer
PATCH /customer/lock
PATCH /customer/unlock
GET /customer/export
PATCH /customer/forget
Transaction
GET /transaction/transaction_payout_preview
PATCH /transaction/transaction_update_revenue_by_orderid
PATCH /transaction/transaction_update_revenue_by_transaction_hash
POST /transaction/process_void
POST /transaction/process_chargeback
POST /transaction/process_reversal
GET /transaction/click_details
Creatives Admin
The Creatives Admin
Add New Creatives
Add New Creative Type
Tracking Code
Code Builder
Track and Strack
Setting Rules
  Default Creative Types
Creative Types
Image Banners
Flash Banners
Dynamic Text Banners
Feeds
Mailers
Video Download
Video Embed
Page Peels
IM Popups
Footer Ads
Page Ads
Overlays
Communications Admin
The Communications Admin
Add News Item
Sending Messages
Signup Questions
Configuration Admin
The Configuration Admin
Affiliate Signup Postback URL
Edit Affiliate Text
Edit CSS Colors
Misc.
Rules
Freeform Date
Affiliate Custom Signup
Tracking Code
Tracking in NATS For Networks
Void Conversions Remotely

== POST /offer/add_commission_change ==

Description

  • add_commission_change adds a new offer


Resource URL

  • http://domain/api/offer/add_commission_change
  • Replace domain with the NATS For Networks domain

Response Format

  • JSON

Request Method

  • POST

Authentication

  • HTTP headers

Parameters

  • offerid
    • type: int
    • required
    • Id of the offer that contains the commission changes being edited.
  • type
    • type: string
    • options: standard,disable,temporary
    • required
    • Disable automatically sets all payout fields to 0. Temporary lets you set a start and end date to schedule when the payout change will be in effect. Standard is everything else.
  • username
    • type: string
    • Username of affiliate to restrict this new commission change to.
  • loginid
    • type: int
    • Loginid of affiliate to restrict this new commission change to.
  • countries
    • type: Array
    • Array of 2 character iso2 country codes to restrict this new commission change to
  • countries
    • type: Array
    • Array of 2 character iso2 country codes to restrict this new commission change to
  • subaff
    • type: string
    • Optional affiliate subaff value to restrict this new commission change to
  • subaff2
    • type: string
    • Optional affiliate subaff2 value to restrict this new commission change to
  • subaff3
    • type: string
    • Optional affiliate subaff3 value to restrict this new commission change to
  • subaff4
    • type: string
    • Optional affiliate subaff4 value to restrict this new commission change to
  • subaff5
    • type: string
    • Optional affiliate subaff5 value to restrict this new commission change to
  • start_time
    • type: string
    • Start time for type=temporary. String to time is run on this field.
  • end_time
    • type: string
    • End time for type=temporary. String to time is run on this field.
  • goalid
    • type: int
    • The offer goal id visible in the edit offer details page or from get_commission_changes. Default 0 updates the main offer commission changes instead of goal specific commissions
  • flat_amount_per_click
    • type: decimal'
    • Flat commission paid for every raw click. Works with click or hybrid offers
  • flat_amount_per_visitor
    • type: decimal'
    • Flat commission paid for every unique click. Works with click or hybrid offers
  • flat_amount_per_conversion
    • type: decimal'
    • Flat commission paid for every conversion. Works with cpa or hybrid offers
  • flat_amount_per_continuity
    • type: decimal'
    • Flat commission paid for every continuity. Works with cpa or hybrid offers
  • percentage_of_customer_conversion
    • type: decimal'
    • Percentage of conversion revenue to pay as commission. Works with cps or hybrid offers
  • percentage_of_customer_continuity
    • type: decimal'
    • Percentage of continuity revenue to pay as commission. Works with cps or hybrid offers
  • aff_manager_payout
    • type: bool'
    • Only applies to goal changes. Specifies if events posted to this goal should trigger affiliate manager payouts if applicable.
  • aff_referral_payout
    • type: bool'
    • Only applies to goal changes. Specifies if events posted to this goal should trigger affiliate referral payouts if applicable.
  • offer_partner_payout
    • type: bool'
    • Only applies to goal changes. Specifies if events posted to this goal should trigger offer partner payouts if applicable.



Example Request

POST


http://domain/api/offer/add_commission_change
loginid=2
offerid=2
type=standard
countries[0] = GB
countries[1] = DE
flat_amount_per_conversion=15
flat_amount_per_continuity=5


  • Response:
{
    "result":"Success",
    "message": 'changes_saved',
    "changeid": 59
}

Example Code

PHP

<?php 
$url = 'http://domain/api/offer/add_commission_change';
$curl = curl_init(); 
 
$headers = array( 
    'api-key: 44b5498dbcb481a0d00b404c0169af62', 
    'api-username: productsupport' 
);

 $data = Array(
    'offerid' => 2,
    'loginid' => 2,
    'type' => 'standard',
    'countries' => Array('GB,DE'),
    'flat_amount_per_conversion' => 15,
    'flat_amount_per_continuity' => 5,
); 

curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); 
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); 
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
                                                  
$resp = curl_exec($curl); 
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
	//json was valid. Dump the decoded array
	print_r($output);
}
else {
	//invalid json, just dump the raw response
	print_r($resp);
}
// Close request to clear up some resources 
curl_close($curl); 
?>