Offerit REST API Ping - Revision history

OfferitRob at 16:20, 27 August 2018

2018-08-27T16:20:51Z

Offeritnick at 21:18, 12 May 2017

2017-05-12T21:18:54Z

Offeritnick: /* Example Code */

2017-05-12T21:09:18Z

‎Example Code

OfferitRob at 20:46, 22 March 2017

2017-03-22T20:46:10Z

OfferitDave: 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..."

2016-01-05T13:10:09Z

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..."

New page

{{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 the API.

'''Resource URL'''
*<nowiki>http://domain/api/service/ping</nowiki>
*Replace domain with the nats domain

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
*None

== '''Example Request''' ==

'''GET'''

<nowiki>http://domain/api/service/ping</nowiki>

*Response:
<pre>true</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?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);
?>
</pre>

[[Category:Offerit API Articles]]

@@ Line 52: / Line 52: @@
 if($output !== NULL) {
 	//json was valid. Dump the decoded array
-	var_dump($output);
+	print_r($output);
+}
 else {
 	//invalid json, just dump the raw response
-	var_dump($resp);
+	print_r($resp);
-−
+}
 // Close request to clear up some resources
 curl_close($curl);

@@ Line 8: / Line 8: @@
 '''Resource URL'''
 *<nowiki>http://domain/api/service/ping</nowiki>
-*Replace domain with the nats domain
+*Replace domain with the Offerit domain
 '''Response Format'''

@@ Line 48: / Line 48: @@
 $resp = curl_exec($curl);
-//dumps an associative array representation of the json
+//dumps an associative array representation of the json response
-var_dump(json_decode($resp, true));
+$output = json_decode($resp, true);
 // Close request to clear up some resources
 curl_close($curl);

@@ Line 1: / Line 1: @@
 {{Offerit Manual
-| show_api_admin_section = true
+| show_rest_api_section= true
 }}
 == '''GET /service/ping''' ==