Difference between revisions of "Offerit REST API Get Links"

Latest revision as of 12:47, 28 July 2020

GET /affiliate/get_links

Description

• Gets all tracking links for an affiliate. Optionally lets you limit to a specific offer or landing page.

Resource URL

• http://domain/api/affiliate/get_links

Response Format

• JSON

Request Method

• GET

Authentication

• HTTP headers

Parameters

• loginid
  • type: int
  • required
  • affiliate to get link for
• offerid
  • type: int
  • Optional offer to get link for
• landing_pageid
  • type: int
  • Optional landing page to get link for. Defaults to default lander for the offer.
• style
  • type: string
  • options: encoded,ids,shortnames,tiny
  • Optional link style. Defaults to encoded.
• subaff
  • type: string
  • Optional subaff value. Defaults to none.
• subaff2
  • type: string
  • Optional subaff2 value. Defaults to none.
• subaff3
  • type: string
  • Optional subaff3 value. Defaults to none.
• subaff4
  • type: string
  • Optional subaff4 value. Defaults to none.
• subaff5
  • type: string
  • Optional subaff5 value. Defaults to none.
• subids
  • type: string
  • Optional comma separated list of subids. Defaults to none.
• _ocid
  • type: string
  • Optional click id value. Defaults to none.
• code_only
  • type: Bool
  • Optional - returns only the code from the tracking link. Defaults to full url.
• get_countries
  • type: Bool
  • Optional - return the authorized and unauthorized countries for each link.
• get_commission
  • type: Bool
  • Optional - return the commission string for each link.
• get_hidden
  • type: Int
  • Optional - 0 to return landing pages that are not hidden, 1 only hidden landing pages, 2 all. If not sent, will behave as if you passed 0 for only landing pages that are not hidden.
• get_hidden_offers
  • type: Int
  • Optional - 0 to return offers that are not hidden, 1 only hidden offers, 2 all offers. If not sent, will behave as if you passed 2 for all offers.
• get_advertiser
  • type: Bool
  • Optional - return the advertiser id and username for each link

Example Request

GET

http://domain/api/affiliate/get_links?loginid=2&offerid=1&subaff=test&_ocid={token}

• Response:

{
  "result":"Success",
  "message":[
    {
      "Offer Id":277,
      "Offer Name":"01dave",
      "Landing Page Id":425,
      "Landing Page Name":"lp333", 
      "Code":"http:\/\/example.com\/track\/Mi4yNjguMjc3LjQyNS4wLjAuMC4wLjAuNjIuMC4w?subaff=test&_ocid={token}"
    },
    {
      "Offer Id":277,
      "Offer Name":"01dave",
      "Landing Page Id":304,
      "Landing Page Name":"offerit offer",
      "Code":"http:\/\/example.com\/track\/Mi4yNjguMjc3LjMwNC4wLjAuMC4wLjAuNjIuMC4w?subaff=test&_ocid={token}"
    }
  ]
}  

Example Code

PHP

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


$data = Array(
  'loginid' => 2,
  'offerid' => 1,
  'subaff' => 'test',
  '_ocid' => '{token}'
);                                                   

$data_string = http_build_query($data);
$url .= '?'.$data_string;

curl_setopt($curl, CURLOPT_GET, 1);
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 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); 
?>