unifi-php-api/examples
malle-pietje 49d0986bd7 API client class v1.1.51
- updated README with all getter and setter methods/functions
- updated get_cookies() and get_cookie() for consistency
- get_cookie() remains for backward compatibility only, should not be used in new code
- fix rare cases where the client would end up in a loop, e.g. issuing a request for a site the cached credentials have no
access to
2020-03-19 16:07:31 +01:00
..
site_provisioning_example
ap_scanning_state.php
ap_upgrade_firmware.php API client class v1.1.43 2019-12-13 09:15:10 +01:00
auth_guest_basic.php
auth_guest_with_note.php
block_list.php API client class v1.1.51 2020-03-19 16:07:31 +01:00
change_super_mgmt.php
change_wlan_password.php
config.template.php API client class v1.1.47 2020-02-06 08:52:49 +01:00
create_site.php
create_voucher.php
delete_site.php
disable_device.php
execute_custom_api_request.php
extend_guest_auth.php
list_alarms.php
list_ap_connected_users.php
list_connected_users.php API client class v1.1.43 2019-12-13 09:15:10 +01:00
list_site_health.php
list_social_auth_details.php
list_user_stats.php
README.md
reconnect_client.php API client class v1.1.44 2020-01-27 13:19:49 +01:00
test_connection.php API client class v1.1.49 2020-02-07 08:27:39 +01:00
toggle_led.php
unblock_list.php
update_ac-iw_ports.php
update_device_wlan_settings_5.5.X.php
update_switch_poe-mode.php code cleanup and improvements in preparation of support for UniFi OS-based controllers 2020-02-04 07:41:43 +01:00

API client class usage examples

This directory contains some PHP code examples which demonstrate usage of the PHP API client class and can be used as a good starting point for your own custom code.

Usage

Copy the appropriate example file to your working directory together with a copy of the config.template.php file which should be renamed to config.php. Then update the contents of your new config.php with your controller details and credentials and modify the example file as required to fit your needs.

Also make sure to update the path for the composer autoloader file (vendor/autoload.php) or the file containing the Class itself (src/Client.php) in your require_once() statement as required.

Executing scripts from the CLI

Most of the included example scripts can be run from the CLI or shell as follows after the necessary credentials and parameters have been added or updated:

$ php list_site_health.php

NOTE: this does require the php-cli module to be installed

Contribute

If you would like to share your own example file(s), please open an issue and include your code there or else create a pull request.

Important Disclaimer

Use these examples at your own risk!