Difference between revisions of "NATS4 REST API Ping"
From TMM Wiki
Jump to navigationJump to search| Line 3: | Line 3: | ||
}} | }} | ||
== '''GET ping''' == | == '''GET ping''' == | ||
| − | + | '''Description''' | |
| − | Ping is a test function to make sure that you can successfully connect to the API. | + | *Ping is a test function to make sure that you can successfully connect to the API. |
| − | |||
'''Resource URL''' | '''Resource URL''' | ||
*<nowiki>http://domain/api/v1/ping</nowiki> | *<nowiki>http://domain/api/v1/ping</nowiki> | ||
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| − | |||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| + | '''[[NATS4_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']] | ||
| + | *GET | ||
| − | '''Authentication''' | + | '''[[NATS4_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| − | |||
== '''Parameters''' == | == '''Parameters''' == | ||
| − | '''URL params''' | + | '''URL/Request body params''' |
*None | *None | ||
| − | + | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== '''Example Request''' == | == '''Example Request''' == | ||
| − | GET | + | '''GET''' |
<nowiki>http://domain/api/v1/ping</nowiki> | <nowiki>http://domain/api/v1/ping</nowiki> | ||
Revision as of 17:31, 11 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/v1/ping
- Replace domain with the nats domain
Response Format
- JSON
- GET
- HTTP headers
Parameters
URL/Request body params
- None
Example Request
GET
http://domain/api/v1/ping
- Response:
true
Example Code
PHP
<?php
$url = 'http://domain/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://domain/api/v1/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/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);
Curl
curl -X GET 'http://domain/api/v1/ping' -H "api_key: 44b5498dbcb481a0d00b404c0169af62" -H "api_username: tmm1phrvezsbu"
