mirror of
https://github.com/Art-of-WiFi/UniFi-API-client.git
synced 2024-11-25 11:40:48 +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
48 lines
1.4 KiB
PHP
Executable File
48 lines
1.4 KiB
PHP
Executable File
<?php
|
|
/**
|
|
* PHP API usage example
|
|
*
|
|
* contributed by: Art of WiFi
|
|
* description: example basic PHP script to execute a custom API request using the
|
|
* custom_api_request() function/method
|
|
*/
|
|
|
|
/**
|
|
* 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 site to authorize the device with
|
|
* https://github.com/Art-of-WiFi/UniFi-API-client#important-notes
|
|
*/
|
|
$site_id = '<enter your site id here>';
|
|
|
|
/**
|
|
* parameters
|
|
*/
|
|
$url = '/api/s/' . $site_id . '/stat/fwupdate/latest-version';
|
|
$request_method = 'GET';
|
|
$payload = null;
|
|
$return = 'array';
|
|
|
|
/**
|
|
* 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();
|
|
$results = $unifi_connection->custom_api_request($url, $request_method, $payload, $return);
|
|
|
|
/**
|
|
* provide feedback in JSON format or as PHP Object
|
|
*/
|
|
echo json_encode($results, JSON_PRETTY_PRINT);
|
|
//print_r($results);
|