Difference between revisions of "Offerit REST API Pause Offer"
From Offerit
OfferitRob (talk | contribs) (Created page with "{{Offerit Manual | show_api_admin_section = true }} == '''GET /offer/pause_offer''' == '''Description''' *Offerit supports an API resource to pause an offer and send the tra...") |
Offeritnick (talk | contribs) |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Offerit Manual | {{Offerit Manual | ||
| − | | | + | | show_rest_api_section = true |
}} | }} | ||
| Line 22: | Line 22: | ||
== '''Parameters''' == | == '''Parameters''' == | ||
| − | *offerid: | + | *offerid: the id of the offer to be paused |
**'''''type: integer''''' | **'''''type: integer''''' | ||
| − | **required | + | **'''''required''''' |
| − | *date_expire: | + | *date_expire: date or unix timestamp to set as the expiration date. Leaving this blank will make the expiration immediate |
**'''''type: string''''' | **'''''type: string''''' | ||
| − | *expiration_landing_page_id: | + | *expiration_landing_page_id: the id of the landing page you want the traffic redirected to |
**'''''type: integer''''' | **'''''type: integer''''' | ||
| − | *expire_url: | + | *expire_url: the expiration url you want traffic redirected to (expiration_landing_page_id takes precedence over this if both are sent) |
**'''''type: string''''' | **'''''type: string''''' | ||
| + | |||
| + | == '''Example Request''' == | ||
| + | |||
| + | '''PATCH''' | ||
| + | |||
| + | <nowiki>http://domain/api/offer/pause_offer</nowiki> | ||
| + | |||
| + | |||
| + | *Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "result": "success", | ||
| + | "message": "Offer expired." | ||
| + | } | ||
| + | </pre> | ||
== '''Example Code''' == | == '''Example Code''' == | ||
| Line 58: | Line 73: | ||
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); | curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); | ||
curl_setopt($curl, CURLOPT_URL, $url); | curl_setopt($curl, CURLOPT_URL, $url); | ||
| + | curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH"); | ||
| + | |||
$resp = curl_exec($curl); | $resp = curl_exec($curl); | ||
| − | //dumps an associative array representation of the json | + | //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 | // Close request to clear up some resources | ||
curl_close($curl); | curl_close($curl); | ||
Latest revision as of 16:29, 12 May 2017
GET /offer/pause_offer
Description
- Offerit supports an API resource to pause an offer and send the traffic to another offer/landing page or expiration url.
Resource URL
- http://domain/api/offer/pause_offer
- Replace domain with the Offerit domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
- offerid: the id of the offer to be paused
- type: integer
- required
- date_expire: date or unix timestamp to set as the expiration date. Leaving this blank will make the expiration immediate
- type: string
- expiration_landing_page_id: the id of the landing page you want the traffic redirected to
- type: integer
- expire_url: the expiration url you want traffic redirected to (expiration_landing_page_id takes precedence over this if both are sent)
- type: string
Example Request
PATCH
http://domain/api/offer/pause_offer
- Response:
{
"result": "success",
"message": "Offer expired."
}
Example Code
PHP
<?php
$curl = curl_init();
$data = array(
'offerid' => 4,
'date_expire' => '2017/03/20',
'expiration_landing_page_id' => 17
);
$data_string = http_build_query($data);
$url = 'http://domain/api/offer/pause_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);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
$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);
?>
