Difference between revisions of "Offerit REST API Ping"

Revision as of 09:10, 5 January 2016

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: 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 
var_dump(json_decode($resp, true)); 
// Close request to clear up some resources 
curl_close($curl); 
?>