mirror of
https://github.com/Art-of-WiFi/UniFi-API-client.git
synced 2024-11-22 10:10:18 +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
37 lines
1.1 KiB
PHP
Executable File
37 lines
1.1 KiB
PHP
Executable File
<?php
|
|
/**
|
|
* PHP API usage example
|
|
*
|
|
* contributed by: @gahujipo
|
|
* description: example to pull connected users and their details from the UniFi controller and output the results
|
|
* in JSON format
|
|
*/
|
|
/**
|
|
* 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';
|
|
|
|
/**
|
|
* the short name of the site which you wish to query
|
|
*/
|
|
$site_id = '<enter your site id here>';
|
|
|
|
/**
|
|
* initialize the UniFi API connection class and log in to the controller and pull the requested data
|
|
*/
|
|
$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
|
|
$set_debug_mode = $unifi_connection->set_debug($debug);
|
|
$loginresults = $unifi_connection->login();
|
|
$clients_array = $unifi_connection->list_clients();
|
|
|
|
/**
|
|
* output the results in JSON format
|
|
*/
|
|
header('Content-Type: application/json; charset=utf-8');
|
|
echo json_encode($clients_array); |