Offerit REST API Store Offer Ips

From Offerit
Jump to: navigation, search
Offerit
REST API
General
Offerit REST API Overview
GET /service/ping
Advertiser
PATCH /advertiser/edit_advertiser
POST /advertiser/add_advertiser
Affiliate
GET /affiliate/get_links
GET /affiliate/get_single_link
GET /affiliate/search
PATCH /affiliate/edit_affiliate
PATCH /affiliate/payvia
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

PATCH /offer/store_offer_ips

Description

  • store_offer_ips edits the allowed ips for an existing landing page


Resource URL

  • http://domain/api/offer/store_offer_ips
  • Replace domain with the Offerit domain

Response Format

  • JSON

Request Method

  • PATCH

Authentication

  • HTTP headers

Parameters

  • ips
    • type: Array
    • required
    • possible keys: postback_ips, void_ips, hostnpost_ips
    • Array containing at least one of the possible keys above specifying what type of ips to update. The value will be either a comma separate list or an array of ips to store for that type.
  • targets
    • type: Array
    • required
    • possible keys: advertiserids, offerids, landing_pageids
    • Array containing at least one of the possible keys above specifying landing pages to apply the ips to. The value will be either a comma separate list or an array of offer ids, landing page ids, or advertiser ids .

If you pass offer ids, all landing pages in those offers will be affected. If you pass advertiser ids, all landing pages of all offers associated with those advertisers will be affected.



Example Request

PATCH


http://domain/api/offer/store_offer_ips
targets[landing_pageids] = 1,2,3
ips[postback_ips] = 1.1.1.1,2.2.2.2,3.3.3.3
ips[void_ips] = 1.1.1.1,2.2.2.2,3.3.3.3


  • Response:
{
   "result":"Success","message":{
      "1":{
         "postback_ips":{
               "1.1.1.1":true,
               "2.2.2.2":true,
               "3.3.3.3":true
         },
         "void_ips":{
               "1.1.1.1":true,
               "2.2.2.2":true,
               "3.3.3.3":true
         }
      },
      "2":{
         "postback_ips":{
               "1.1.1.1":true,
               "2.2.2.2":true,
               "3.3.3.3":true
         },
         "void_ips":{
               "1.1.1.1":true,
               "2.2.2.2":true,
               "3.3.3.3":true
         }
      },
      "3":{
         "postback_ips":{
               "1.1.1.1":true,
               "2.2.2.2":true,
               "3.3.3.3":true
         },
         "void_ips":{
               "1.1.1.1":true,
               "2.2.2.2":true,
               "3.3.3.3":true
         }
      },    
      
}
      

Example Code

PHP

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

 $data = Array(
    'targets' => Array('landing_pageids' => "1,2,3"),
    'ips' => Array(
        'postback_ips' => "1.1.1.1,2.2.2.2,3.3.3.3",
        'void_ips' => "1.1.1.1,2.2.2.2,3.3.3.3",
    ),

); 

curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); 
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); 
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
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); 
?>