Offerit REST API Get Single Link - Revision history

Offeritnick: /* Example Code */

2019-01-15T23:52:11Z

‎Example Code

Offeritnick: /* Parameters */

2019-01-15T23:52:05Z

‎Parameters

Offeritnick: /* Example Code */

2019-01-15T23:51:43Z

‎Example Code

Offeritnick: /* Parameters */

2019-01-15T23:51:01Z

‎Parameters

Offeritnick at 21:22, 12 May 2017

2017-05-12T21:22:42Z

Offeritnick: /* Example Code */

2017-05-12T21:12:00Z

‎Example Code

OfferitDave: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''GET /affiliate/get_single_link''' == '''Description''' *Gets the default affiliate tracking link for an offer. Opti..."

2017-03-23T22:14:01Z

Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''GET /affiliate/get_single_link''' == '''Description''' *Gets the default affiliate tracking link for an offer. Opti..."

New page

{{Offerit Manual
| show_rest_api_section = true
}}
== '''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'''
*<nowiki>http://domain/api/affiliate/get_single_link</nowiki>

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''[[Offerit_REST_API_Overview#Authentication|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'''

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

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

== '''Example Code''' ==

'''PHP'''
<pre>
<?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
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

@@ Line 95: / Line 95: @@
    'subaff' => 'test',
    '_ocid' => '{token}',
 );

@@ Line 112: / Line 112: @@
 if($output !== NULL) {
 	//json was valid. Dump the decoded array
-	var_dump($output);
+	print_r($output);
+}
 else {
 	//invalid json, just dump the raw response
-	var_dump($resp);
+	print_r($resp);
+}
 // Close request to clear up some resources

@@ Line 58: / Line 58: @@
 *code_only
 **'''''type: Bool'''''
-** Optional - returns only the code from the tracking link. Defaults to full url.
+** Optional - returns only the code from the tracking link. Defaults to full url
 == '''Example Request''' ==

@@ Line 108: / Line 108: @@
 $resp = curl_exec($curl);
-//dumps an associative array representation of the json
+//dumps an associative array representation of the json response
-var_dump(json_decode($resp, true));
+$output = json_decode($resp, true);
 // Close request to clear up some resources
 curl_close($curl);