NATS For Networks REST Get Single Link

From TMMwiki
Jump to: navigation, search
NATS For Networks
REST API
General
API Overview
GET /service/ping
Advertiser
POST /advertiser/add_advertiser
PATCH /advertiser/edit_advertiser
Affiliate
GET /affiliate/get_links
GET /affiliate/get_single_link
GET /affiliate/search
PATCH /affiliate/edit_affiliate
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
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

GET /affiliate/get_single_link

Description

  • Gets the default affiliate tracking link for an offer. Optionally lets you specify an individual landing page.

Resource URL

  • http://domain/api/affiliate/get_single_link


Response Format

  • JSON

Request Method

  • GET

Authentication

  • HTTP headers

Parameters

  • loginid
    • type: int
    • required
    • affiliate to get link for
  • offerid
    • type: int
    • required
    • 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.


Example Request

GET

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


  • Response:
{
  "result":"Success",
  "message":"http:\/\/example.com\/track\/Mi4yNjguMjc3LjMwNC4wLjAuMC4wLjAuNjIuMC4w?subaff=test&_ocid={token}"
}

Example Code

PHP

<?php 
$url = 'http://domain/api/affiliate/get_single_link';
$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); 
?>