NATS4 REST API Affiliate Get Campaigns
From TMM Wiki
Jump to navigationJump to searchThe printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
GET affiliate/campaigns
Description
- This API resource allows you to get a list of affiliate campaigns by using the affiliate/campaigns endpoint.
Resource URL
- http://domain/api/affiliate/campaigns
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params..
- loginid: The affiliate ID. This parameter is required.
- type: integer
- required
- start: The number of campaigns to skip from the beginning. Useful when returning a lot of campaigns. Default: 0 meaning start at the beginning of the campaign list.
- type: integer
- optional
- count: The number of campaigns to return. Default: 0 meaning all campaigns are returned..
- type: integer
- optional
- orderby: How to order the return of campaigns. Default: name. Available options are campaignid or name. You can sort ascending or descending by adding ASC or DESC to the orderby parameter.
- type: string
- optional
Example Request
GET
http://domain/api/affiliate/campaigns
- Response:
[ { "campaignid": 0, "name": "Default" }, { "campaignid": 2, "name": "hsbc" }, { "campaignid": 1, "name": "detente,fates warning,carnivore,voivod" } ]
Example Code
PHP
<?php $curl = curl_init(); $data = array( 'start' => 1, 'count' => 3, 'orderby' => 'campaignid DESC', ); $data_string = http_build_query($data); $url = 'http://domain/api/affiliate/campaigns?'.$data_string; $headers = array( 'api-key: 44b5498dbcb481a0d00b404c0169af62', 'api-username: tmm1phrvezsbu' ); 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); ?>
Python
- This example requires pip and the request library which can be installed via pip by: 'pip install requests'
import requests url = 'http://domain/api/affiliate/campaigns' params = { 'start': 1, 'count': 3, 'orderby': 'campaignid DESC', } headers = { 'api-key': '44b5498dbcb481a0d00b404c0169af62', 'api-username': 'tmm1phrvezsbu' } res = requests.get(url, params=params, headers=headers) print res.json()
node.js
- This example requires npm and the request module which can be installed via npm by: 'npm install request'
var request = require('request'); var options = { url: 'http://domain/api/affiliate/campaigns', method: 'GET', qs: { 'start': 1, 'count': 3, 'orderby': 'campaignid DESC', }, json: true, headers: { 'api-key': '44b5498dbcb481a0d00b404c0169af62', 'api-username': 'tmm1phrvezsbu' } }; function callback(error, response, body) { if (!error && response.statusCode == 200) { console.log(body); } else{ console.log(body); } } request(options, callback);
Curl
curl -X GET 'http://domain/api/affiliate/campaigns?start=1&count=3&orderby=campaignid DESC' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu"