API: PHP

Das folgende Beispiel enthält ein auf der cURL-Bibliothek basierendes PHP-Skript, das eine Anfrage durchführt, und eine Seite mit einigen Beispielen für API-Aufrufe, die auf diesem Skript basieren; einschließlich Autorisierung, Abrufen einer Liste von Plattformen, Abrufen einer Geräteliste nach Plattform, Erstellen eines Zeitplans und einer Benachrichtigungsgruppe.

Dieses Skript enthält eine Hauptanforderungsfunktion, die auf einer PHP cURL-Bibliothek basiert, die API-Methoden aufruft und als Ergebnis ein JSON-Objekt anzeigt.

CODE:

[php] 
<encoded_tag_open />?php 
// constant Dotcom-Monitor API v.1 address 
$API_URL = ‘https://api.dotcom-monitor.com/config_api_v1/’; 
// $action – dynamic url part 
// $method – HTTP method 
// $data – POST data, ‘null’ for GET request 
function Request($action, $method, $data) { 
// accessing global variable 
global $API_URL; 
// setting request url (merging “constant” and “dynamic” part) 
$ch = curl_init($API_URL . $action); 
// setting HTTP method 
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method); 
// return string 
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); 
// igroring SSL certificate 
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); 
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); 
// Cookie management 
curl_setopt($ch, CURLOPT_COOKIEFILE, ‘D:\PhpExample\cookie.txt’); 
curl_setopt($ch, CURLOPT_COOKIEJAR, ‘D:\PhpExample\cookie.txt’); 
// creating request header array 
$headers = array(‘Content-Type: application/json’); 
// checking if ‘POST’ method 
if($method === ‘POST’ && $data != null) 
{ 
// encode input data to json 
$data_string = json_encode($data); 
// setting POST data 
curl_setopt($ch, CURLOPT_POSTFIELDS, $data_string); 
// setting content length header 
array_push($headers, ‘Content-Length: ‘ . strlen($data_string)); 
} 
// setting headers 
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); 
// making request 
$result = curl_exec($ch); 
// closing connection 
curl_close($ch); 
// displaying response 
echo $result; 
// returning deserialized json data as object 
return json_decode($result); 
} 
?<encoded_tag_closed /> 
[/php]

Seite enthält Beispiele für die Autorisierung, die Auflistung von Ressourcen, die Erstellung von Geräten und die einfache Verwaltung von Benachrichtigungsgruppen und Vorlagen.

CODE:

[php] 
<encoded_tag_open />!– including request function –<encoded_tag_closed /> 
<encoded_tag_open />?php include ‘request.php’; ?<encoded_tag_closed /> 
<encoded_tag_open />!DOCTYPE html<encoded_tag_closed /> 
<encoded_tag_open />!– css styles to make page readable –<encoded_tag_closed /> 
<encoded_tag_open />head<encoded_tag_closed /> 
<encoded_tag_open />style type=”text/css”<encoded_tag_closed /> 
.request 
{ 
background-color: #D3DEE2; 
font-weight: bold; 
padding: 8px; 
} 
.response 
{ 
background-color: #EFEFEF; 
border: 1px solid #1D4982; 
margin-bottom: 25px; 
overflow: auto; 
padding: 5px; 
} 
.monitor 
{ 
float: left; 
width: 215px; 
overflow: hidden; 
text-overflow: ellipsis; 
height: 22px; 
} 
.radio_block 
{ 
float: left; 
width: 100px; 
overflow: hidden; 
} 
.form_param 
{ 
border-bottom: 1px solid #C0C0C0; 
padding-top: 10px; 
clear: both; 
font-weight: bold; 
overflow: hidden; 
margin-bottom: 5px; 
} 
fieldset { background-color: #F4F8FF; } 
fieldset legend { 
font-weight: bold; 
font-size: 1.2em; 
} 
<encoded_tag_open />/style<encoded_tag_closed /> 
<encoded_tag_open />/head<encoded_tag_closed /> 
<encoded_tag_open />body<encoded_tag_closed /> 
<encoded_tag_open />h1<encoded_tag_closed /><encoded_tag_open />?php echo $API_URL; ?<encoded_tag_closed /><encoded_tag_open />/h1<encoded_tag_closed /> 
<encoded_tag_open />!– Performing Log on and displaying result –<encoded_tag_closed /> 
<encoded_tag_open />div class=”request”<encoded_tag_closed />Log on<encoded_tag_open />/div<encoded_tag_closed /> 
<encoded_tag_open />div class=”response”<encoded_tag_closed /> 
<encoded_tag_open />?php 
$credentials = array(“UserName” =<encoded_tag_closed /> “your_username”, “Password” =<encoded_tag_closed /> “your_password”); 
Request(‘login’, “POST”, $credentials); // making login request with credentials (authorization) 
?<encoded_tag_closed /> 
<encoded_tag_open />/div<encoded_tag_closed /> 
<encoded_tag_open />!– Requesting platforms information and displaying result –<encoded_tag_closed /> 
<encoded_tag_open />div class=”request”<encoded_tag_closed />Get platforms<encoded_tag_open />/div<encoded_tag_closed /> 
<encoded_tag_open />div class=”response”<encoded_tag_closed /> 
<encoded_tag_open />?php 
// get all platforms 
$result = Request(‘platforms’, “GET”, null); 
// adding received data into a variable for further usage 
$platforms = $result; 
?<encoded_tag_closed /> 
<encoded_tag_open />/div<encoded_tag_closed /> 
<encoded_tag_open />!– Requesting device list by each available platform and displaying result –<encoded_tag_closed /> 
<encoded_tag_open />div class=”request”<encoded_tag_closed />Devices by platform<encoded_tag_open />/div<encoded_tag_closed /> 
<encoded_tag_open />div class=”response”<encoded_tag_closed /> 
<encoded_tag_open />?php 
// variable for any first ServerView device, if available 
$device_id = 0; 
// iterating through all platforms 
foreach ($platforms as &$platform) { 
echo ‘<encoded_tag_open />strong<encoded_tag_closed />’ . $platform -<encoded_tag_closed /> Name . ‘<encoded_tag_open />/strong<encoded_tag_closed />:<encoded_tag_open />br /<encoded_tag_closed />’; 
//requesting devices for platfotm 
$result = Request(“devices/” . $platform -<encoded_tag_closed /> Name, “GET”, null); 
echo ‘<encoded_tag_open />br /<encoded_tag_closed />’; 
// checking for ServerView platform 
if ($platform -<encoded_tag_closed /> Id == 1) 
{ 
$max = sizeof($result); 
for($i = 0; $i <encoded_tag_open /> $max; $i++) 
// get first id and break loop 
{ 
$device_id = $result[$i]; 
break; 
} 
} 
} 
echo ‘<encoded_tag_open />/div<encoded_tag_closed />’; 
if ($device_id <encoded_tag_closed /> 0) 
{ 
echo ‘<encoded_tag_open />div class=”request”<encoded_tag_closed />Edit device with id: ‘ . $device_id . ‘<encoded_tag_open />/div<encoded_tag_closed />’; 
echo ‘<encoded_tag_open />div class=”response”<encoded_tag_closed />Load:<encoded_tag_open />br /<encoded_tag_closed />’; 
// loading device by id 
$device = Request(“device/” . $device_id, “GET”, null); 
echo ‘<encoded_tag_open />/div<encoded_tag_closed />’; 
echo ‘<encoded_tag_open />div class=”response”<encoded_tag_closed />Save:<encoded_tag_open />br /<encoded_tag_closed />’; 
// changing device name from “device_name” to “device_name (edited)” 
$device -<encoded_tag_closed /> Name = $device -<encoded_tag_closed /> Name . ” (edited)”; 
// save edited device 
Request(“device/” . $device_id, “POST”, $device); 
echo ‘<encoded_tag_open />/div<encoded_tag_closed />’; 
} 
?<encoded_tag_closed />
<encoded_tag_open />!– before we can create device, we have to receive required device properties –<encoded_tag_closed /> 
<encoded_tag_open />h2<encoded_tag_closed />Create device<encoded_tag_open />/h2<encoded_tag_closed /> 
<encoded_tag_open />div class=”request”<encoded_tag_closed />Locations for ServerView<encoded_tag_open />/div<encoded_tag_closed /> 
<encoded_tag_open />div class=”response”<encoded_tag_closed /><encoded_tag_open />?php $locations = Request(‘locations/serverview’, “GET”, null); ?<encoded_tag_closed /><encoded_tag_open />/div<encoded_tag_closed /> 
<encoded_tag_open />div class=”request”<encoded_tag_closed />Frequencies for ServerView<encoded_tag_open />/div<encoded_tag_closed /> 
<encoded_tag_open />div class=”response”<encoded_tag_closed /><encoded_tag_open />?php $frequencies = Request(‘frequencies/serverview’, “GET”, null); ?<encoded_tag_closed /><encoded_tag_open />/div<encoded_tag_closed /> 
<encoded_tag_open />div class=”request”<encoded_tag_closed />Get schedulers<encoded_tag_open />/div<encoded_tag_closed /> 
<encoded_tag_open />div class=”response”<encoded_tag_closed /><encoded_tag_open />?php $schedulers = Request(‘schedulers’, “GET”, null); ?<encoded_tag_closed /><encoded_tag_open />/div<encoded_tag_closed /> 
<encoded_tag_open />div class=”request”<encoded_tag_closed />Get Notification Groups<encoded_tag_open />/div<encoded_tag_closed /> 
<encoded_tag_open />div class=”response”<encoded_tag_closed /><encoded_tag_open />?php $groups = Request(‘groups’, “GET”, null); ?<encoded_tag_closed /><encoded_tag_open />/div<encoded_tag_closed /> 
<encoded_tag_open />div class=”request”<encoded_tag_closed />Get Filters<encoded_tag_open />/div<encoded_tag_closed /> 
<encoded_tag_open />div class=”response”<encoded_tag_closed /><encoded_tag_open />?php $filters = Request(‘filters’, “GET”, null); ?<encoded_tag_closed /><encoded_tag_open />/div<encoded_tag_closed />
<encoded_tag_open />br /<encoded_tag_closed /> 
<encoded_tag_open />!– listing previously requested data –<encoded_tag_closed /> 
<encoded_tag_open />fieldset<encoded_tag_closed /> 
<encoded_tag_open />legend<encoded_tag_closed />Create device<encoded_tag_open />/legend<encoded_tag_closed /> 
<encoded_tag_open />form action=”example.php?create_device=true” method=”post”<encoded_tag_closed /> 
<encoded_tag_open />?php 
echo ‘<encoded_tag_open />div class=”form_param”<encoded_tag_closed />Locations<encoded_tag_open />/div<encoded_tag_closed />’; 
foreach($locations as $location) { 
echo ‘<encoded_tag_open />div class=”monitor”<encoded_tag_closed /><encoded_tag_open />input type=”checkbox” name=”locations[]” value=”‘ . $location -<encoded_tag_closed /> Id . ‘” /<encoded_tag_closed />’ . $location -<encoded_tag_closed /> Name . ‘<encoded_tag_open />/div<encoded_tag_closed />’; 
} 
echo ‘<encoded_tag_open />div class=”form_param”<encoded_tag_closed />Frequency<encoded_tag_open />/div<encoded_tag_closed />’; 
foreach($frequencies as $frequency) { 
echo ‘<encoded_tag_open />div class=”radio_block”<encoded_tag_closed /><encoded_tag_open />input type=”radio” name=”frequency” value=”‘ . $frequency . ‘” /<encoded_tag_closed />’ . $frequency . ‘<encoded_tag_open />/div<encoded_tag_closed />’; 
} 
echo ‘<encoded_tag_open />div class=”form_param”<encoded_tag_closed />Filter<encoded_tag_open />/div<encoded_tag_closed />’; 
foreach($filters as $filter) { 
echo ‘<encoded_tag_open />div class=”radio_block”<encoded_tag_closed /><encoded_tag_open />input type=”radio” name=”filter” value=”‘ . $filter . ‘” /<encoded_tag_closed />’ . $filter . ‘<encoded_tag_open />/div<encoded_tag_closed />’; 
} 
echo ‘<encoded_tag_open />div class=”form_param”<encoded_tag_closed />Scheduler<encoded_tag_open />/div<encoded_tag_closed />’; 
foreach($schedulers as $scheduler) { 
echo ‘<encoded_tag_open />div class=”radio_block”<encoded_tag_closed /><encoded_tag_open />input type=”radio” name=”scheduler” value=”‘ . $scheduler . ‘” /<encoded_tag_closed />’ . $scheduler . ‘<encoded_tag_open />/div<encoded_tag_closed />’; 
} 
echo ‘<encoded_tag_open />div class=”form_param”<encoded_tag_closed />Notifications<encoded_tag_open />/div<encoded_tag_closed />’; 
foreach($groups as $group) { 
echo ‘<encoded_tag_open />input type=”checkbox” name=”notifications[]” value=”‘ . $group . ‘” /<encoded_tag_closed />’ . $group . ‘ – Time Shift: ‘; 
echo ‘<encoded_tag_open />input type=”text” name=”notification’ . $group . ‘” value=”10″ /<encoded_tag_closed /> min <encoded_tag_open />br /<encoded_tag_closed />’; 
} 
echo ‘<encoded_tag_open />div class=”form_param”<encoded_tag_closed />Device name<encoded_tag_open />/div<encoded_tag_closed />’; 
echo ‘<encoded_tag_open />input type=”text” name=”device_name” value=”” /<encoded_tag_closed />’; 
echo ‘<encoded_tag_open />div class=”form_param”<encoded_tag_closed />Notification email<encoded_tag_open />/div<encoded_tag_closed />’; 
echo ‘<encoded_tag_open />input type=”text” name=”email” value=”” /<encoded_tag_closed />’; 
// POST handler for device creation 
if ($_POST && !empty($_GET[‘create_device’])) { 
$notificationGroups = array(); 
$locationsArray = array(); 
if(!empty($_POST[‘notifications’])) { 
foreach($_POST[‘notifications’] as $check) { 
array_push( $notificationGroups, array(“Id” =<encoded_tag_closed /> intval($check), “Time_Shift_Min” =<encoded_tag_closed /> $_POST[‘notification’ . $check])); 
} 
} 
if(!empty($_POST[‘locations’])) { 
foreach($_POST[‘locations’] as $check) { 
array_push( $locationsArray, intval($check)); 
} 
} 
// creating device object to be created 
$data = array( 
“Avoid_Simultaneous_Checks” =<encoded_tag_closed /> true, 
“False_Positive_Check” =<encoded_tag_closed /> false, 
“Send_Uptime_Alert” =<encoded_tag_closed /> false, 
“Platform_Id” =<encoded_tag_closed /> 1, 
“Locations” =<encoded_tag_closed /> $locationsArray, 
“Frequency” =<encoded_tag_closed /> intval($_POST[‘frequency’]), 
“Filter_Id” =<encoded_tag_closed /> intval($_POST[‘filter’]), 
“Scheduler_Id” =<encoded_tag_closed /> intval($_POST[‘scheduler’]), 
“Name” =<encoded_tag_closed /> $_POST[‘device_name’], 
“Notifications” =<encoded_tag_closed /> array( 
“E_Mail_Flag” =<encoded_tag_closed /> true, 
“E_Mail_Address” =<encoded_tag_closed /> $_POST[’email’], 
“Notification_Groups” =<encoded_tag_closed /> $notificationGroups 
) 
); 
echo ‘<encoded_tag_open />br /<encoded_tag_closed /><encoded_tag_open />br /<encoded_tag_closed /><encoded_tag_open />div class=”request”<encoded_tag_closed />Result<encoded_tag_open />/div<encoded_tag_closed />’; 
echo ‘<encoded_tag_open />div class=”response”<encoded_tag_closed />’; 
Request(“devices?verb=PUT”, “POST”, $data); //creating device 
echo ‘<encoded_tag_open />/div<encoded_tag_closed />’; 
} 
?<encoded_tag_closed /> 
<encoded_tag_open />p<encoded_tag_closed /> 
<encoded_tag_open />input type=”submit” value=”Create device” /<encoded_tag_closed /> 
<encoded_tag_open />/p<encoded_tag_closed /> 
<encoded_tag_open />/form<encoded_tag_closed /> 
<encoded_tag_open />/fieldset<encoded_tag_closed /> 
<encoded_tag_open />h2<encoded_tag_closed />Create scheduler<encoded_tag_open />/h2<encoded_tag_closed /> 
<encoded_tag_open />fieldset<encoded_tag_closed /> 
<encoded_tag_open />legend<encoded_tag_closed />Create scheduler<encoded_tag_open />/legend<encoded_tag_closed /> 
<encoded_tag_open />form action=”example.php?create_scheduler=true” method=”post”<encoded_tag_closed /> 
<encoded_tag_open />?php 
echo ‘<encoded_tag_open />div class=”form_param”<encoded_tag_closed />Name<encoded_tag_open />/div<encoded_tag_closed />’; 
echo ‘<encoded_tag_open />input type=”text” name=”name” value=”” /<encoded_tag_closed />’; 
echo ‘<encoded_tag_open />div class=”form_param”<encoded_tag_closed />Description<encoded_tag_open />/div<encoded_tag_closed />’; 
echo ‘<encoded_tag_open />input type=”text” name=”description” value=”” /<encoded_tag_closed />’; 
if ($_POST && !empty($_GET[‘create_scheduler’])) { 
// creating scheduler object 
$data = array( 
“Name” =<encoded_tag_closed /> $_POST[‘name’], 
“Description” =<encoded_tag_closed /> $_POST[‘description’], 
“Weekly_Intervals” =<encoded_tag_closed /> array( 
array( 
“Days” =<encoded_tag_closed /> array(“Su”, “Mo”, “Tu”, “We”, “Th”, “Fr”, “Sa”), 
“From_Min” =<encoded_tag_closed /> 0, 
“To_Min” =<encoded_tag_closed /> 1025, 
“Included” =<encoded_tag_closed /> true 
), array( 
“Days” =<encoded_tag_closed /> array(“Su”, “Sa”), 
“From_Min” =<encoded_tag_closed /> 0, 
“To_Min” =<encoded_tag_closed /> 1139, 
“Included” =<encoded_tag_closed /> false 
), array( 
“Days” =<encoded_tag_closed /> array(“Su”, “Mo”, “Fr”, “Sa”), 
“From_Min” =<encoded_tag_closed /> 120, 
“To_Min” =<encoded_tag_closed /> 240, 
“Included” =<encoded_tag_closed /> false 
) 
), 
“Date_Time_Intervals” =<encoded_tag_closed /> array( 
“From” =<encoded_tag_closed /> 1358712000000, 
“To” =<encoded_tag_closed /> 1358798400000 
) 
); 
echo ‘<encoded_tag_open />br /<encoded_tag_closed /><encoded_tag_open />br /<encoded_tag_closed /><encoded_tag_open />div class=”request”<encoded_tag_closed />Result<encoded_tag_open />/div<encoded_tag_closed />’; 
echo ‘<encoded_tag_open />div class=”response”<encoded_tag_closed />’; 
Request(“schedulers?verb=PUT”, “POST”, $data); //making create request 
echo ‘<encoded_tag_open />/div<encoded_tag_closed />’; 
} 
?<encoded_tag_closed /> 
<encoded_tag_open />p<encoded_tag_closed /> 
<encoded_tag_open />input type=”submit” value=”Create scheduler” /<encoded_tag_closed /> 
<encoded_tag_open />/p<encoded_tag_closed /> 
<encoded_tag_open />/form<encoded_tag_closed /> 
<encoded_tag_open />/fieldset<encoded_tag_closed />
<encoded_tag_open />h2<encoded_tag_closed />Create notification group<encoded_tag_open />/h2<encoded_tag_closed /> 
<encoded_tag_open />fieldset<encoded_tag_closed /> 
<encoded_tag_open />legend<encoded_tag_closed />Create notification group<encoded_tag_open />/legend<encoded_tag_closed /> 
<encoded_tag_open />form action=”example.php?create_group=true” method=”post”<encoded_tag_closed /> 
<encoded_tag_open />?php 
echo ‘<encoded_tag_open />div class=”form_param”<encoded_tag_closed />Name<encoded_tag_open />/div<encoded_tag_closed />’; 
echo ‘<encoded_tag_open />input type=”text” name=”name” value=”” /<encoded_tag_closed />’; 
if ($_POST && !empty($_GET[‘create_group’])) { 
// creating notification group with requered fields 
$data = array( 
“Name” =<encoded_tag_closed /> $_POST[‘name’], 
“Scheduler_Id” =<encoded_tag_closed /> 0 
); 
echo ‘<encoded_tag_open />br /<encoded_tag_closed /><encoded_tag_open />br /<encoded_tag_closed /><encoded_tag_open />div class=”request”<encoded_tag_closed />Result<encoded_tag_open />/div<encoded_tag_closed />’; 
echo ‘<encoded_tag_open />div class=”response”<encoded_tag_closed />’; 
Request(“groups?verb=PUT”, “POST”, $data); //making request 
echo ‘<encoded_tag_open />/div<encoded_tag_closed />’; 
} 
?<encoded_tag_closed /> 
<encoded_tag_open />p<encoded_tag_closed /> 
<encoded_tag_open />input type=”submit” value=”Create notification group” /<encoded_tag_closed /> 
<encoded_tag_open />/p<encoded_tag_closed /> 
<encoded_tag_open />/form<encoded_tag_closed /> 
<encoded_tag_open />/fieldset<encoded_tag_closed /> 
<encoded_tag_open />/body<encoded_tag_closed /> 
<encoded_tag_open />/html<encoded_tag_closed /> 
[/php]