Difference between revisions of "NATS For Networks REST API Ping"

From TMM Wiki
Jump to navigationJump to search
(Created page with "{{NATS For Networks Manual | show_api_admin_section = true }} == '''GET /ping''' == '''Description''' *Ping is a test endpoint to make sure that you can successfully connect...")
 
Line 2: Line 2:
 
| show_api_admin_section = true
 
| show_api_admin_section = true
 
}}
 
}}
−
== '''GET /ping''' ==
+
== '''GET /service/ping''' ==
 
'''Description'''  
 
'''Description'''  
 
*Ping is a test endpoint to make sure that you can successfully connect to the API.  
 
*Ping is a test endpoint to make sure that you can successfully connect to the API.  
  
 
'''Resource URL'''
 
'''Resource URL'''
−
*<nowiki>http://domain/api/ping</nowiki>
+
*<nowiki>http://domain/api/service/ping</nowiki>
 
*Replace domain with the nats domain
 
*Replace domain with the nats domain
  
Line 26: Line 26:
 
'''GET'''
 
'''GET'''
  
−
<nowiki>http://domain/api/ping</nowiki>
+
<nowiki>http://domain/api/service/ping</nowiki>
  
 
*Response:  
 
*Response:  
Line 36: Line 36:
 
<pre>
 
<pre>
 
<?php  
 
<?php  
−
$url = 'http://domain/api/ping'
+
$url = 'http://domain/api/service/ping'
 
$curl = curl_init();  
 
$curl = curl_init();  
 
   
 
   
Line 53: Line 53:
 
curl_close($curl);  
 
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/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/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/ping' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu"
 
 
</pre>
 
</pre>
  
  
 
[[Category:NATS For Networks API Articles]]
 
[[Category:NATS For Networks API Articles]]

Revision as of 11:28, 28 September 2015

Template:NATS For Networks Manual

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

Request Method

  • GET

Authentication

  • HTTP headers

Parameters

  • None

Example Request

GET

http://domain/api/service/ping

  • Response:
true

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 
var_dump(json_decode($resp, true)); 
// Close request to clear up some resources 
curl_close($curl); 
?>
Retrieved from "https://tmmwiki.com/index.php?title=NATS_For_Networks_REST_API_Ping&oldid=22690"