NATS4 REST API Ping
From TMM Wiki
Revision as of 19:36, 10 March 2015 by Tmmtobias0185 (talk | contribs)
GET ping
Ping is a test function to make sure that you can successfully connect to the API.
Resource URL
- http://domain/api/v1/ping
- Replace domain with the nats domain
Response Format
- JSON
Authentication
- HTTP headers
Parameters
- None
HTTP headers
- api_key: Affiliate api key
- api_username: Affiliate user name
Example Request
GET
http://nats.tobias-dev.com/api/v1/ping
- Response:
true
Example Code
PHP
<?php
$url = 'http://nats.tobias-dev.com/api/v1/ping
$curl = curl_init();
$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://nats.tobias-dev.com/api/v1/payvia'
headers = {
'api_key': '44b5498dbcb481a0d00b404c0169af62',
'api_username': 'tmm1phrvezsbu'
}
params = {
'payvia_type_id': 1,
'rule_type': 'enabled'
}
res = requests.get(url, params=params, headers=headers)
print res.json()
NodeJS
- 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://nats.tobias-dev.com/api/v1/ping',
method: 'GET',
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);
