Difference between revisions of "Offerit REST API Ping"
From Offerit
OfferitDave (talk | contribs) (Created page with "{{Offerit Manual | show_api_admin_section = true }} == '''GET /service/ping''' == '''Description''' *Ping is a test endpoint to make sure that you can successfully connect to...") |
OfferitRob (talk | contribs) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Offerit Manual | {{Offerit Manual | ||
| − | | | + | | show_rest_api_section= true |
}} | }} | ||
== '''GET /service/ping''' == | == '''GET /service/ping''' == | ||
| Line 8: | Line 8: | ||
'''Resource URL''' | '''Resource URL''' | ||
*<nowiki>http://domain/api/service/ping</nowiki> | *<nowiki>http://domain/api/service/ping</nowiki> | ||
| − | *Replace domain with the | + | *Replace domain with the Offerit domain |
'''Response Format''' | '''Response Format''' | ||
| 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 | ||
| + | print_r($output); | ||
| + | } | ||
| + | else { | ||
| + | //invalid json, just dump the raw response | ||
| + | print_r($resp); | ||
| + | } | ||
// Close request to clear up some resources | // Close request to clear up some resources | ||
curl_close($curl); | curl_close($curl); | ||
Latest revision as of 11:20, 27 August 2018
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 Offerit 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
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>
