mirror of
https://github.com/Art-of-WiFi/UniFi-API-client.git
synced 2024-12-25 18:30:15 +01:00
bf3446bba0
- added information to several docblocks
- changed handling of request headers, added private property for this
- applied changes for improved use of require_once in the README and examples
- added `list_sites()` example
- *potential breaking changes:*
renamed `get_request_type()` and `set_request_type()` functions/methods to `get_request_method()` and `set_request_method()` respectively
46 lines
1.2 KiB
PHP
Executable File
46 lines
1.2 KiB
PHP
Executable File
<?php
|
|
/**
|
|
* PHP API usage example
|
|
*
|
|
* contributed by: Art of WiFi
|
|
* description: example basic PHP script to list all site on the controller that are
|
|
* available to the admin account defined in config.php
|
|
*/
|
|
|
|
/**
|
|
* using the composer autoloader
|
|
*/
|
|
require_once 'vendor/autoload.php';
|
|
|
|
/**
|
|
* include the config file (place your credentials etc. there if not already present)
|
|
* see the config.template.php file for an example
|
|
*/
|
|
require_once 'config.php';
|
|
|
|
/**
|
|
* we use the default site in the initial connection
|
|
*/
|
|
$site_id = 'default';
|
|
|
|
/**
|
|
* initialize the UniFi API connection class and log in to the controller and do our thing
|
|
*/
|
|
$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
|
|
$set_debug_mode = $unifi_connection->set_debug($debug);
|
|
$loginresults = $unifi_connection->login();
|
|
$data = $unifi_connection->list_sites();
|
|
|
|
/**
|
|
* we can render the full results in json format
|
|
*/
|
|
//echo json_encode($data, JSON_PRETTY_PRINT);
|
|
|
|
/**
|
|
* or we print each site name and site id
|
|
*/
|
|
foreach ($data as $site) {
|
|
echo 'Site name: ' . $site->desc . ', site id: ' . $site->name . PHP_EOL;
|
|
}
|
|
|
|
echo PHP_EOL; |