unifi-php-api/examples
malle-pietje b3521d8c1d updated main README to include the newly added functions/methods
added example to demonstrate the use of set_super_mgmt_settings_base()
2019-10-15 14:16:23 +02: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.41 2019-04-29 17:35:09 +02: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
change_super_mgmt.php updated main README to include the newly added functions/methods 2019-10-15 14:16:23 +02:00
change_wlan_password.php
config.template.php
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
list_alarms.php
list_ap_connected_users.php
list_site_health.php
list_social_auth_details.php
list_user_stats.php
README.md API client class v1.1.37 2018-11-05 12:18:10 +01:00
test_connection.php
toggle_led.php
unblock_list.php
update_ac-iw_ports.php
update_device_wlan_settings_5.5.X.php

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!