Difference between revisions of "Offerit REST API Ping"
From Offerit
OfferitRob (talk | contribs) |
Offeritnick (talk | contribs) (→Example Code) |
||
| Line 48: | Line 48: | ||
$resp = curl_exec($curl); | $resp = curl_exec($curl); | ||
| − | //dumps an associative array representation of the json | + | //dumps an associative array representation of the json response |
| − | + | $output = json_decode($resp, true); | |
| + | if($output !== NULL) { | ||
| + | //json was valid. Dump the decoded array | ||
| + | var_dump($output); | ||
| + | } | ||
| + | else { | ||
| + | //invalid json, just dump the raw response | ||
| + | var_dump($resp); | ||
| + | } | ||
// Close request to clear up some resources | // Close request to clear up some resources | ||
curl_close($curl); | curl_close($curl); | ||
Revision as of 16:09, 12 May 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:
true
Example Code
PHP
<?php
$url = 'http://domain/api/service/ping'
$curl = curl_init();
$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
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 response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
var_dump($output);
}
else {
//invalid json, just dump the raw response
var_dump($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>
