Difference between revisions of "NATS For Networks REST Get Links"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS For Networks Manual | show_api_admin_section = true }} == '''GET /affiliate/get_links''' == '''Description''' *Gets all tracking links for an affiliate. Optionally l...") |
|||
Line 1: | Line 1: | ||
− | {{NATS | + | {{NATS for Networks Manual |
− | | | + | | show_rest_api_section = true |
}} | }} | ||
== '''GET /affiliate/get_links''' == | == '''GET /affiliate/get_links''' == |
Revision as of 12:35, 12 May 2017
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
- 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.
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 var_dump(json_decode($resp, true)); // Close request to clear up some resources curl_close($curl); ?>