Difference between revisions of "NATS4 REST API Service GET project"
From TMM Wiki
Jump to navigationJump to search| Line 30: | Line 30: | ||
"project": { | "project": { | ||
"name": "NATS", | "name": "NATS", | ||
| − | "nice_name": " | + | "nice_name": "NATS5", |
"hostname": "democash.com", | "hostname": "democash.com", | ||
"api_permission_level": 100 | "api_permission_level": 100 | ||
| Line 36: | Line 36: | ||
} | } | ||
</pre> | </pre> | ||
| − | |||
| − | |||
| − | |||
== '''Example Code''' == | == '''Example Code''' == | ||
Latest revision as of 10:39, 5 August 2019
GET /service/project
Description
- Get information on this NATS project
Resource URL
- http://domain/api/service/project
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
None
Example Request
Method: GET
URL: http://domain/api/service/project
Response:
{
"success": true,
"project": {
"name": "NATS",
"nice_name": "NATS5",
"hostname": "democash.com",
"api_permission_level": 100
}
}
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();
$request = Array(
'method' => 'GET',
'path' => 'v1/service/project',
'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);
?>
