Offeritnick at 21:32, 12 May 2017

2017-05-12T21:32:09Z

Offeritnick: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''PATCH /offer/store_offer_ips''' == '''Description''' *store_offer_ips edits the allowed ips for an existing landing..."

2017-05-11T22:10:42Z

Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''PATCH /offer/store_offer_ips''' == '''Description''' *store_offer_ips edits the allowed ips for an existing landing..."

New page

{{Offerit Manual
| show_rest_api_section = true
}}
== '''PATCH /offer/store_offer_ips''' ==
'''Description'''
*store_offer_ips edits the allowed ips for an existing landing page

'''Resource URL'''
*<nowiki>http://domain/api/offer/store_offer_ips</nowiki>
*Replace domain with the Offerit domain

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*PATCH

'''[[Offerit_REST_API_Overview#Authentication|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'''
<pre>
<nowiki>
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
</nowiki>
</pre>

*Response:
<pre>
{
"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
}
},

}

</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?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
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

@@ Line 124: / Line 124: @@
 $resp = curl_exec($curl);
-//dumps an associative array representation of the json
+//dumps an associative array representation of the json response
-var_dump(json_decode($resp, true));
+$output = json_decode($resp, true);
 // Close request to clear up some resources
 curl_close($curl);

Offerit REST API Store Offer Ips - Revision history

Offeritnick at 21:32, 12 May 2017

Offeritnick: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''PATCH /offer/store_offer_ips''' == '''Description''' *store_offer_ips edits the allowed ips for an existing landing..."