NATS For Networks REST API Pause Offer

From TMMwiki
Jump to: navigation, search
NATS For Networks
REST API
General
API Overview
GET /service/ping
Advertiser
POST /advertiser/add_advertiser
PATCH /advertiser/edit_advertiser
Affiliate
GET /affiliate/get_links
GET /affiliate/get_single_link
GET /affiliate/search
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
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
Transaction
GET /transaction/transaction_payout_preview
PATCH /transaction/transaction_update_revenue_by_orderid
PATCH /transaction/transaction_update_revenue_by_transaction_hash

GET /offer/pause_offer

Description

  • NATS for Networks supports an API resource to pause an offer and send the traffic to another offer/landing page or expiration url.


Resource URL

  • http://domain/api/offer/pause_offer
  • Replace domain with the NATS for Networks domain

Request Method

  • PATCH

Response Format

  • JSON

Authentication

  • HTTP headers

Parameters

  • offerid: the id of the offer to be paused
    • type: integer
    • required
  • date_expire: date or unix timestamp to set as the expiration date. Leaving this blank will make the expiration immediate
    • type: string
  • expiration_landing_page_id: the id of the landing page you want the traffic redirected to
    • type: integer
  • expire_url: the expiration url you want traffic redirected to (expiration_landing_page_id takes precedence over this if both are sent)
    • type: string

Example Request

PATCH

http://domain/api/offer/pause_offer


  • Response:
{
   "result": "success",
   "message": "Offer expired."
}


Example Code

PHP

<?php
$curl = curl_init();

$data = array(
    'offerid' => 4,
    'date_expire' => '2017/03/20',
    'expiration_landing_page_id' => 17
);

$data_string = http_build_query($data);
$url = 'http://domain/api/offer/pause_offer?'.$data_string;

$headers = array(
    'api-key: 44b5498dbcb481a0d00b404c0169af62',
    'api-username: productsupport'
);
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 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);
?>