Offerit REST API Activate Offer - Revision history

Offeritnick at 21:29, 12 May 2017

2017-05-12T21:29:18Z

OfferitRob at 16:39, 23 March 2017

2017-03-23T16:39:42Z

OfferitDave: /* Example Code */

2017-03-22T21:50:14Z

‎Example Code

OfferitRob at 20:51, 22 March 2017

2017-03-22T20:51:19Z

OfferitRob at 15:57, 22 March 2017

2017-03-22T15:57:45Z

OfferitRob: Created page with "{{Offerit Manual | show_api_admin_section = true }} == '''GET /offer/activate_offer''' == '''Description''' *Offerit supports an API resource to activate a paused/expired of..."

2017-03-22T15:57:14Z

Created page with "{{Offerit Manual | show_api_admin_section = true }} == '''GET /offer/activate_offer''' == '''Description''' *Offerit supports an API resource to activate a paused/expired of..."

New page

{{Offerit Manual
| show_api_admin_section = true
}}

== '''GET /offer/activate_offer''' ==
'''Description'''
*Offerit supports an API resource to activate a paused/expired offer and allow traffic to the landing page url.

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

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

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
*offerid: is the id of the offer to be activated
**'''''type: integer'''''
**required

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

'''PHP'''
<pre>
<?php
$curl = curl_init();

$data = array(
'offerid' => 4,
);

$data_string = http_build_query($data);
$url = 'http://domain/api/offer/activate_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
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>

</pre>

[[Category:Offerit API Articles]]

@@ Line 66: / Line 66: @@
 $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);

@@ Line 24: / Line 24: @@
 *offerid: the id of the offer to be activated
 **'''''type: integer'''''
-**required
+**'''''required'''''
 == '''Example Code''' ==

@@ Line 47: / Line 47: @@
 curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
 curl_setopt($curl, CURLOPT_URL, $url);
 $resp = curl_exec($curl);

@@ Line 1: / Line 1: @@
 {{Offerit Manual
-| show_api_admin_section = true
+| show_rest_api_section = true
 }}