Offerit REST API Add Landing Page

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
Customer
PATCH /customer/set_customer_details
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 /offer/add_landing_page

Description

  • add_landing_page adds a new landing page to an existing offer


Resource URL

  • http://domain/api/offer/add_landing_page
  • Replace domain with the Offerit domain

Response Format

  • JSON

Request Method

  • POST

Authentication

  • HTTP headers

Parameters

  • name
    • type: string
    • required
    • Name of this landing page
  • offerid
    • type: int
    • required
    • Id of the offer this landing page is being added to
  • url
    • type: string
    • required
    • Landing Page url
  • preview_url
    • type: string
    • Clean url to display to affiliates
  • tracking_domain
    • type: string
    • One of your already defined tracking domains
  • description
    • type: string
    • Landing page description for affiliates to see.
  • thumb_url
    • type: string
    • Url of offer thumbnail image.
  • force_url
    • type: string
    • Url to screenshot for thumbnail.
  • language
    • type: int'
    • id of one of your defined languages from the offers admin.
  • conversion_type
    • type: string
    • options: iframe,post,image
    • Type of conversion to use for this offer
  • postback_ips
    • type: string
    • Comma separated list of ips that are allowed to post conversions to this offer. Default is no restriction
  • hostnpost_ips
    • type: string
    • Comma separated list of ips that are allowed to post hostandpost conversions to this offer. Default is no restriction
  • void_ips
    • type: string
    • Comma separated list of ips that are allowed to post voids to this offer. Default is deny all.
  • private
    • type: bool
    • TRUE means the default landing page for the new offer will be private. Default is FALSE.
  • requestable
    • type: bool
    • TRUE means the default landing page for the new offer will be requestable if it is also private. Default is FALSE.
  • internal_desc
    • type: string
    • Landing page description for the new offer that is only in the admin interface. Default is empty.
  • redirect_hash
    • type: string
    • Matching field for identifying what landing page to use when geo redirecting within an offer group. Default is empty.
  • disable_url_sanitization
    • type: bool
    • Uses landing page url exactly as provided without encoding any invalid url characters. Default is false, encoding invalid url characters in the landing page.
  • disable_deep_linking
    • type: bool
    • Discards any extra path and variables specified by the affilaite on the tracking link. Default is false, allowing the affiliate to affect the landing page url.
  • hidden
    • type: string
    • Offer does not show up in the affiliate offer list.
  • date_live
    • type: string
    • Time when landing page should become available to affiliates. String to time on the string provided. Default is to start immediately.
  • date_expire
    • type: string
    • Time when landing page should stop being available to affiliates. String to time on the string provided. Default is to end never.
  • order_by
    • type: int
    • Optional ordering to use when multiple landing pages are visible to the affiliate. Lower numbers are displayed first. Default is 0 which displays after any custom ordered landing pages.


Example Request

POST


http://domain/api/offer/add_landing_page
offerid=400
name=API TEST Landing Page
url=http://example.com/?id=%%click_hash%%
preview_url=http://example.com/
private=TRUE
requestable=TRUE
description=A second apply to run landing page


  • Response:
{
    "result":"Success",
    "message":{
      "landing_pageid":"434",
    }
}

Example Code

PHP

<?php 
$url = 'http://domain/api/offer/add_landing_page';
$curl = curl_init(); 
 
$headers = array( 
    'api-key: 44b5498dbcb481a0d00b404c0169af62', 
    'api-username: productsupport' 
);

 $data = Array(
    'offerid' => 400,
    'name' => 'API TEST Landing Page',
    'url' => 'http://example.com/?id=%%click_hash%%',
    'preview_url' => 'http://example.com/',
    'private' => TRUE,
    'requestable' => TRUE,
    'description' => 'A second apply to run landing page'

); 

curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); 
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); 
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
                                                  
$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); 
?>