Difference between revisions of "Offerit REST API Get Single Link"
From Offerit
Offeritnick (talk | contribs) |
Offeritnick (talk | contribs) (→Parameters) |
||
| Line 59: | Line 59: | ||
**'''''type: Bool''''' | **'''''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. | ||
| − | + | *get_countries <font color="red">(COMING SOON)</font> | |
| + | **'''''type: Bool''''' | ||
| + | ** Optional - return the authorized and unauthorized countries for each link. | ||
== '''Example Request''' == | == '''Example Request''' == | ||
Revision as of 19:51, 15 January 2019
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
- GET
- 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.
- get_countries (COMING SOON)
- type: Bool
- Optional - return the authorized and unauthorized countries for each link.
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);
?>
