Difference between revisions of "NATS4 REST API Ping"
From TMM Wiki
Jump to navigationJump to search| Line 7: | Line 7: | ||
'''Resource URL''' | '''Resource URL''' | ||
| − | *<nowiki>http://domain/api | + | *<nowiki>http://domain/api/ping</nowiki> |
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| Line 26: | Line 26: | ||
'''GET''' | '''GET''' | ||
| − | <nowiki>http://domain/api | + | <nowiki>http://domain/api/ping</nowiki> |
*Response: | *Response: | ||
| Line 36: | Line 36: | ||
<pre> | <pre> | ||
<?php | <?php | ||
| − | $url = 'http://domain/api | + | $url = 'http://domain/api/ping |
$curl = curl_init(); | $curl = curl_init(); | ||
| Line 60: | Line 60: | ||
import requests | import requests | ||
| − | url = 'http://domain/api | + | url = 'http://domain/api/ping' |
headers = { | headers = { | ||
'api_key': '44b5498dbcb481a0d00b404c0169af62', | 'api_key': '44b5498dbcb481a0d00b404c0169af62', | ||
| Line 80: | Line 80: | ||
var options = { | var options = { | ||
| − | url: 'http://domain/api | + | url: 'http://domain/api/ping', |
method: 'GET', | method: 'GET', | ||
json: true, | json: true, | ||
| Line 104: | Line 104: | ||
'''Curl''' | '''Curl''' | ||
<pre> | <pre> | ||
| − | curl -X GET 'http://domain/api | + | curl -X GET 'http://domain/api/ping' -H "api_key: 44b5498dbcb481a0d00b404c0169af62" -H "api_username: tmm1phrvezsbu" |
</pre> | </pre> | ||
[[Category:NATS4 API Articles]] | [[Category:NATS4 API Articles]] | ||
Revision as of 18:00, 13 March 2015
GET ping
Description
- Ping is a test function to make sure that you can successfully connect to the API.
Resource URL
- http://domain/api/ping
- Replace domain with the nats domain
Response Format
- JSON
- GET
- HTTP headers
Parameters
- None
Example Request
GET
http://domain/api/ping
- Response:
true
Example Code
PHP
<?php
$url = 'http://domain/api/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://domain/api/ping'
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()
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/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);
Curl
curl -X GET 'http://domain/api/ping' -H "api_key: 44b5498dbcb481a0d00b404c0169af62" -H "api_username: tmm1phrvezsbu"
