Branch: master
Find file History
malle-pietje API client class v1.1.37
updated both READMEs
added cmd_stat() function, can currently only be used to reset DPI counters for the current site
added optional group_id parameter to list_firewallgroups() which allows you to select a single firewall group, thanks to @VWT-Dan for the suggestion
Latest commit 5389f3a Nov 5, 2018
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
site_provisioning_example General code cleanup (replace tabs by spaces, etc.) Mar 24, 2018
README.md API client class v1.1.37 Nov 5, 2018
ap_scanning_state.php minor changes to examples and README for consistency Sep 7, 2017
ap_upgrade_firmware.php General code cleanup (replace tabs by spaces, etc.) Mar 24, 2018
auth_guest_basic.php minor changes to examples and README for consistency Sep 7, 2017
auth_guest_with_note.php added example to change AC-IW port config Mar 24, 2018
block_list.php removed and added spaces, and changed brackets usage following PSR-2 … Oct 2, 2018
change_wlan_password.php fixed typo in examples/change_wlan_password.php Oct 6, 2017
config.template.php Add ap_upgrade_firmware.php to Examples (#12) Mar 18, 2018
create_site.php minor bugs removed from two examples Feb 1, 2018
create_voucher.php minor code cleanup and various changes: Oct 6, 2017
delete_site.php minor bugs removed from two examples Feb 1, 2018
disable_device.php Update disable_device.php Oct 20, 2017
extend_guest_auth.php removed and added spaces, and changed brackets usage following PSR-2 … Oct 2, 2018
list_alarms.php minor changes to examples and README for consistency Sep 7, 2017
list_ap_connected_users.php General code cleanup (replace tabs by spaces, etc.) Mar 24, 2018
list_site_health.php General code cleanup (replace tabs by spaces, etc.) Mar 24, 2018
list_social_auth_details.php minor changes to examples and README for consistency Sep 7, 2017
list_user_stats.php added user/client device stats methods/functions: Jul 2, 2018
test_connection.php minor code cleanup and various changes: Oct 6, 2017
toggle_led.php minor changes to examples and README for consistency Sep 7, 2017
unblock_list.php removed and added spaces, and changed brackets usage following PSR-2 … Oct 2, 2018
update_ac-iw_ports.php removed and added spaces, and changed brackets usage following PSR-2 … Oct 2, 2018
update_device_wlan_settings_5.5.X.php removed and added spaces, and changed brackets usage following PSR-2 … Oct 2, 2018

README.md

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!