Difference between revisions of "NATS4 REST API Ping"
From TMM Wiki
Jump to navigationJump to search (Blanked the page) |
|||
| (10 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {{NATS4 Manual | ||
| + | | show_api_admin_section = true | ||
| + | }} | ||
| + | == '''GET /service/ping''' == | ||
| + | '''Description''' | ||
| + | *Ping is a test endpoint to make sure that you can successfully connect to the API. | ||
| + | '''Resource URL''' | ||
| + | *<nowiki>http://domain/api/service/ping</nowiki> | ||
| + | *Replace domain with the nats domain | ||
| + | |||
| + | '''Response Format''' | ||
| + | *JSON | ||
| + | |||
| + | '''[[NATS4_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method]]''' | ||
| + | *GET | ||
| + | |||
| + | '''[[NATS4_REST_API_Overview#Authentication|Authentication]]''' | ||
| + | *HTTP headers | ||
| + | |||
| + | == '''Parameters''' == | ||
| + | *None | ||
| + | |||
| + | == '''Example Request''' == | ||
| + | |||
| + | '''GET''' | ||
| + | |||
| + | <nowiki>http://domain/api/service/ping</nowiki> | ||
| + | |||
| + | *Response: | ||
| + | <pre>1</pre> | ||
| + | |||
| + | == '''Example Code''' == | ||
| + | |||
| + | '''PHP''' | ||
| + | <pre> | ||
| + | <?php | ||
| + | $url = 'http://domain/api/service/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 | ||
| + | $output = json_decode($resp,TRUE); | ||
| + | if ($output === NULL) { | ||
| + | print_r($resp); | ||
| + | } | ||
| + | else { | ||
| + | var_dump($output); | ||
| + | } | ||
| + | // Close request to clear up some resources | ||
| + | curl_close($curl); | ||
| + | ?> | ||
| + | </pre> | ||
| + | |||
| + | '''Python''' | ||
| + | *This example requires pip and the request library which can be installed via pip by: 'pip install requests' | ||
| + | <pre> | ||
| + | import requests | ||
| + | |||
| + | url = 'http://domain/api/service/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() | ||
| + | </pre> | ||
| + | |||
| + | '''node.js''' | ||
| + | *This example requires npm and the request module which can be installed via npm by: 'npm install request' | ||
| + | <pre> | ||
| + | var request = require('request'); | ||
| + | |||
| + | var options = { | ||
| + | url: 'http://domain/api/service/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); | ||
| + | </pre> | ||
| + | |||
| + | '''Curl''' | ||
| + | <pre> | ||
| + | curl -X GET 'http://domain/api/service/ping' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu" | ||
| + | </pre> | ||
| + | |||
| + | == '''Legacy Changes''' == | ||
| + | '''''Use the following documentation changes if you are using the REST API with NATS versions below <font style="color: red;">4.1.13.5</font>:''''' | ||
| + | |||
| + | '''Resource URL''' | ||
| + | *<nowiki>http://domain/api/ping</nowiki> | ||
| + | *Replace domain with your nats domain | ||
| + | |||
| + | |||
| + | [[Category:NATS4 API Articles]] | ||
Latest revision as of 10:27, 22 November 2017
GET /service/ping
Description
- Ping is a test endpoint to make sure that you can successfully connect to the API.
Resource URL
- http://domain/api/service/ping
- Replace domain with the nats domain
Response Format
- JSON
- GET
- HTTP headers
Parameters
- None
Example Request
GET
http://domain/api/service/ping
- Response:
1
Example Code
PHP
<?php
$url = 'http://domain/api/service/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
$output = json_decode($resp,TRUE);
if ($output === NULL) {
print_r($resp);
}
else {
var_dump($output);
}
// 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/service/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/service/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/service/ping' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu"
Legacy Changes
Use the following documentation changes if you are using the REST API with NATS versions below 4.1.13.5:
Resource URL
- http://domain/api/ping
- Replace domain with your nats domain
