Difference between revisions of "NATS5 REST API Service GET datetime"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Service GET datetime to NATS5 REST API Service GET datetime: Renaming NATS5 API pages) |
|
(No difference)
| |
Revision as of 15:20, 9 August 2019
GET /service/datetime
Description
- Get a formatted NATS date string, optionally providing a timestamp or a preferred format
Resource URL
- http://domain/api/service/datetime
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- datetime
- type: datetime (A date string to be parsed by php strtotime, or a unix timestamp integer)
- optional
- format
- type: string
- optional
Example Request
Method: GET
URL: http://domain/api/service/datetime
Query String: datetime=31+May+2019
Response:
{
"success": true,
"datetime": "2019-05-31 00:00:00"
}
Example Code
PHP
<?php
$headers = array( //set your username and API key here
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
$url = 'http://yourdomain.com'; //set your NATS URL here
$data = Array(
'datetime' => '31 May 2019',
);
$request = Array(
'method' => 'GET',
'path' => 'v1/service/datetime',
'data' => $data
);
/*code below is the same for (almost) every API call */
$curl = curl_init();
$url = $url.'/api/'.$request['path'];
$query = http_build_query($request['data']);
if($request['method'] == 'GET'){
//add query string parameters to the end of the url
$url = $url.'?'.$query;
}else{
//send parameters as POST fields
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, $query);
if($request['method'] != 'POST'){
$headers[] ='X-HTTP-Method: '.$request['method']; //send custom request method
}
}
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$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);
?>
