Offerit REST API Add Creative Rule
From Offerit
Revision as of 15:50, 22 March 2017 by OfferitRob (talk | contribs)
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
- POST
- 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
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
