22
33A PHP class that provides access to Ubiquiti's [ ** UniFi Network Application** ] ( https://unifi-network.ui.com/ ) API.
44
5- UniFi Network Application software versions 5.X.X, 6.X.X, 7.X.X, and 8.X.X (version ** 8.1.104** has been confirmed to work)
6- are supported as well as Network Applications on ** UniFi OS-based consoles** (UniFi OS ** 3.2.12** has been confirmed to work).
5+ UniFi Network Application software versions 5.X.X, 6.X.X, 7.X.X, and 8.X.X (version ** 8.5.2** has been confirmed to
6+ work) are supported as well as Network Applications on ** UniFi OS-based consoles** (UniFi OS ** 4.0.20** has been
7+ confirmed to work).
8+
79This class is used by our API Browser tool, which can be found
810[ here] ( https://github.com/Art-of-WiFi/UniFi-API-browser ) .
911
@@ -15,12 +17,13 @@ easy inclusion in your projects.
1517## Requirements
1618
1719- a server with:
18- - PHP ** 7.4.0** or higher (use version [ 1.1.83] ( https://github.com/Art-of-WiFi/UniFi-API-client/releases/tag/v1.1.83 ) for PHP 7.3.x and lower)
20+ - PHP ** 7.4.0** or higher (use version [ 1.1.83] ( https://github.com/Art-of-WiFi/UniFi-API-client/releases/tag/v1.1.83 )
21+ for PHP 7.3.x and lower)
1922 - PHP json and PHP cURL modules
20- - tested on Apache 2.4 with PHP 7.4.27 and cURL 7.60.0 and with PHP 8.2.12 and cURL 7.81.0
23+ - tested on Apache 2.4 with PHP 7.4.27 and cURL 7.60.0 and with PHP 8.3.11 and cURL 7.81.0
2124- direct network connectivity between this server and the host and port (usually TCP port 8443 or port 443 for
2225 UniFi OS) where the UniFi Controller is running
23- - you ** must** use ** accounts with local access permissions** to access the UniFi Controller API through this class
26+ - you ** must** use an ** account with local access permissions** to access the UniFi Controller API through this class
2427- do not use UniFi Cloud accounts and do not enable 2FA for the accounts that you use with this class
2528
2629
@@ -34,16 +37,20 @@ Support for UniFi OS-based controllers has been added as of version 1.1.47. Thes
3437- UniFi Cloud Key Gen2 Plus (UCK G2 Plus), firmware version 2.0.24 or higher
3538- UniFi Cloud Console, details [ here] ( https://help.ui.com/hc/en-us/articles/4415364143511 )
3639- UniFi Express (UX)
40+ - UniFi Dream Wall (UDW)
41+ - UniFi Cloud Gateway Ultra (UCG-Ultra)
42+ - UniFi Enterprise Fortress Gateway (EFG)
3743
3844The class automatically detects UniFi OS consoles and adjusts the URLs and several functions/methods accordingly.
3945
40- UniFi OS consoles require you to connect using port ** 443** instead of ** 8443** which is used for "software-based"
41- controllers. If your own code implements strict validation of the URL that is passed to the constructor, please adapt
42- your logic to allow URLs without a port suffix or with port 443 when working with a UniFi OS-based controller.
46+ UniFi OS-based controllers require you to connect using port ** 443** instead of ** 8443** which is used for
47+ "software-based" controllers. If your own code implements strict validation of the URL that is passed to the
48+ constructor, please adapt your logic to allow URLs without a port suffix or with port 443 when working with a
49+ UniFi OS-based controller.
4350
4451
4552### Remote API access to UniFi OS-based controllers
46- When connecting to a UniFi OS gateway through the WAN interface, you need to create a specific firewall rule to
53+ When connecting to a UniFi OS-based gateway through the WAN interface, you need to create a specific firewall rule to
4754allow this. See this blog post on the Art of WiFi website for more details:
4855https://artofwifi.net/blog/how-to-access-the-unifi-controller-by-wan-ip-or-hostname-on-a-udm-pro
4956
0 commit comments