Difference between revisions of "Offerit REST API Decode Trackingcode"

Revision as of 14:13, 14 August 2018

GET /affiliate/decode_trackingcode

Description

• Decodes a given ocode (tracking code) and returns an array of the ids and details that the ocode contains.

Resource URL

• http://domain/api/affiliate/decode_trackingcode

Response Format

• JSON

Request Method

• GET

Authentication

• HTTP headers

Parameters

• ocode
  • type: string
  • required
  • ocode/tracking code to decode

Example Code

PHP

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


$data = Array(
  'ocode' => "MS4xOTIuMTM5LjEyOS4yNC4wLjAuMC4wLjAuMC4w",
);                                                   

$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); 
?> 

Example Output

Array
(
    [loginid] => 1
    [offerid] => 139
    [landing_pageid] => 129
    [campaignid] => 24
    [adtoolid] => 0
    [subid1] => 0
    [subid2] => 0
    [promotionalid] => 0
    [additional_trackingid] => 0
    [is_unencoded] => 0
    [old_code] => 0
    [inhouse] => 1
    [affsubid] => 0
    [affsource] => 0
    [tracked_details] => Array
        (
            [login_details] => Array
                (
                    [loginid] => 1
                    [inhouse] => 1
                    [username] => productsupport
                    [type] => 225
                    [status] => 0
                    [deleted] => 0
                    [affiliate_percentage_override] => 0
                )

            [lp_details] => Array
                (
                    [landing_pageid] => 129
                    [redirect_hash] => 
                    [disable_url_sanitization] => 0
                    [disable_deep_linking] => 0
                    [third_party_partner_id] => 0
                    [url] => http://example.com/?click_hash=%%click_hash%%
                    [allowed_lang] => 
                    [alternativeurl] => 
                    [allowed_lang_track_raw] => 0
                    [allowed_lang_track_unq] => 0
                    [linkdomain] => http://example.offerit.com
                    [offerid] => 139
                    [date_live] => 
                    [date_expire] => 
                    [expire_offer] => 0
                    [expire_program] => 0
                    [expire_url] => 
                )

            [program_details] => Array
                (
                    [programid] => 192
                    [offerid] => 139
                    [type] => 0
                )

            [offer_details] => Array
                (
                    [offerid] => 139
                    [mobile_landing_page] => 0
                    [cost_type] => 
                    [cost_flat] => 0
                    [cost_perc] => 0
                    [geoip_group_redirect] => 0
                    [authorized] => all
                    [unauthorized] => 
                    [offer_limit] => 0
                    [offer_quantity] => 0
                    [conversion_cap] => 0
                    [conversion_trans_type] => 
                    [offer_limit_deduction] => 
                    [ip_uniqueness_seconds] => 0
                    [advertiserid] => 0
                    [remove_ocode] => 0
                    [type] => 0
                    [date_live] => 1518757200
                    [date_expire] => 0
                    [expire_offer] => 0
                    [expire_program] => 0
                    [expire_url] => 
                )

        )

    [payoutid] => 192
    [creativeid] => 0
    [username] => productsupport
)