Offerit REST API Add Creative Rule

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

POST /creative/add_creative_rule

Description

  • get_creative_rule adds a new creative rule

Resource URL

  • http://domain/api/creative/add_creative_rule
  • Replace domain with the Offerit domain

Response Format

  • JSON

Request Method

  • POST

Authentication

  • HTTP headers

Parameters

  • creativeids
    • type: integer,string,array
    • required
    • either creativeids for which you are adding rules. accepts int, comma separated list of ints, array of ints.
  • rule_type
    • type: string
    • required
    • SHOW, HIDE, or IGNORE
  • offerids
    • type: integer,string,array
    • required
    • offer ids that this rule applies to. accepts int, comma separated list of ints, array of ints.
  • landing_pageids
    • type: integer,string,array
    • required
    • landing page ids that this rule applies to. accepts int, comma separated list of ints, array of ints.
  • loginids
    • type: integer,string,array
    • required
    • affiliate login ids that this rule applies to. accepts int, comma separated list of ints, array of ints.
  • start_time
    • type: string
    • optional
    • we will run stringtotime on this. Default Now
  • end_time
    • type: string
    • optional
    • we will run stringtotime on this. Default Never


Example Request

POST

http://domain/api/creative/add_creative_rule?creativeids=1&offerids=1&rule_type=HIDE


  • Response:
{
   "successes": 
   {"13":    
   	{
      "creativeid": "13",
      "ruleid": "57c9b48dee963"
   	}
   },
   "failures": [],
   "total_successes": 1
}

Example Code

PHP

<?php 
$url = 'http://domain/api/creative/add_creative_rule'
$curl = curl_init(); 
 
$headers = array( 
    'api-key: 44b5498dbcb481a0d00b404c0169af62', 
    'api-username: productsupport' 
); 
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); 
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); 
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($curl, CURLOPT_URL, $url); 

$data = Array(
	'creativeids' => 1,
	'start_time' => 'January 1, 2016',
	'offerids' => '1,2,3',
	'rule_type' => 'SHOW',
);                                                   
$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); 
?>