jeroen/unifi-php-api
1
0
Fork 0
mirror of https://github.com/Art-of-WiFi/UniFi-API-client.git synced 2024-11-25 19:51:00 +01:00
Code Issues Packages Projects Releases Wiki Activity

updated README

Browse Source
This commit is contained in:
malle-pietje 2017-09-05 17:22:06 +02:00
parent 8155b81fed
commit 9f79d825c4
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -9,23 +9,6 @@ If you'd like to support further development of this PHP API client class, pleas
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=M7TVNVX3Z44VN)
### Credits
This class is largely based on the work done by the following developers:
- domwo: http://community.ubnt.com/t5/UniFi-Wireless/little-php-class-for-unifi-api/m-p/603051
- fbagnol: https://github.com/fbagnol/class.unifi.php
- and the API as published by Ubiquiti: https://www.ubnt.com/downloads/unifi/5.5.20/unifi_sh_api
### Install
Simply execute this command from your project directory:
```
composer require art-of-wifi/unifi-api-client
```
### Requirements
- a web server with PHP and cURL modules installed (tested on apache2 with PHP Version 5.6.1 and cURL 7.42.1)
- network connectivity between this web server and the server and port (normally port 8443) where the UniFi controller is running
### Methods and functions supported
This class currently supports the following functions/methods to get/set data through the UniFi controller API:
@ -121,6 +104,23 @@ Internal functions:
Please refer to the source code for more details on each function/method and it's parameters.
### Credits
This class is largely based on the work done by the following developers:
- domwo: http://community.ubnt.com/t5/UniFi-Wireless/little-php-class-for-unifi-api/m-p/603051
- fbagnol: https://github.com/fbagnol/class.unifi.php
- and the API as published by Ubiquiti: https://www.ubnt.com/downloads/unifi/5.5.20/unifi_sh_api
### Requirements
- a web server with PHP and cURL modules installed (tested on apache2 with PHP Version 5.6.1 and cURL 7.42.1)
- network connectivity between this web server and the server and port (normally port 8443) where the UniFi controller is running
### Install
Simply execute this command from your project directory:
```
$ composer require art-of-wifi/unifi-api-client
```
### Example usage
A basic example how to use the class:
@ -156,4 +156,4 @@ $results = $unifi_connection->list_alarms(); // returns the alarms in a
Have a look at the files in the `examples` directory for more examples how to use this class.
## Important Disclaimer
Many of these functions are not officially supported by UBNT and as such, may not be supported in future versions of the UniFi controller API.
Many of these functions are not officially supported by UBNT and as such, may not be supported in future versions of the UniFi controller API.