unifi-php-api/examples
malle-pietje 903d3e47d5 API client class v1.1.49
- improvements to internal use of $_SESSION['unificookie']
- other minor code improvements
- applies several applied patches as suggested by scrutinizer-ci.com
2020-02-07 08:27:39 +01:00
..
site_provisioning_example
ap_scanning_state.php API client class v1.1.41 2019-04-29 17:35:09 +02:00
ap_upgrade_firmware.php API client class v1.1.43 2019-12-13 09:15:10 +01:00
auth_guest_basic.php API client class v1.1.42 2019-10-15 14:04:37 +02:00
auth_guest_with_note.php
block_list.php clean up of example code based on feedback from scrutinizer-ci.com 2019-10-15 14:27:28 +02:00
change_super_mgmt.php clean up of example code based on feedback from scrutinizer-ci.com 2019-10-15 14:27:28 +02:00
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 API client class v1.1.41 2019-04-29 17:35:09 +02:00
extend_guest_auth.php fixed minor syntax error/typo in an example 2019-10-15 14:41:16 +02:00
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 clean up of example code based on feedback from scrutinizer-ci.com 2019-10-15 14:27:28 +02:00
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!