Download the PHP package art-of-wifi/unifi-api-client without Composer

On this page you can find all versions of the php package art-of-wifi/unifi-api-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of art-of-wifi/unifi-api-client

Informations about the package unifi-api-client

UniFi Controller API client class

A PHP class that provides access to Ubiquiti's UniFi Network Application API.

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 work) are supported as well as Network Applications on UniFi OS-based consoles (UniFi OS 4.0.20 has been confirmed to work).

This class is used by our API Browser tool, which can be found here.

The package can be installed manually or by using composer/packagist for easy inclusion in your projects.

Requirements

UniFi OS Support

Support for UniFi OS-based controllers has been added as of version 1.1.47. These devices have been verified to work:

The class automatically detects UniFi OS consoles and adjusts the URLs and several functions/methods accordingly.

UniFi OS-based controllers require you to connect using port 443 instead of 8443 which is used for "software-based" controllers. If your own code implements strict validation of the URL that is passed to the constructor, please adapt your logic to allow URLs without a port suffix or with port 443 when working with a UniFi OS-based controller.

Remote API access to UniFi OS-based controllers

When connecting to a UniFi OS-based gateway through the WAN interface, you need to create a specific firewall rule to allow this. See this blog post on the Art of WiFi website for more details: https://artofwifi.net/blog/how-to-access-the-unifi-controller-by-wan-ip-or-hostname-on-a-udm-pro

The "custom firewall rule" approach described there is the recommended method.

Upgrading from a previous version

When upgrading from a version before 1.1.84, please:

Installation

Use Download the Release to install the API client class.

Composer

The preferred installation method is through composer. Follow these installation instructions if you don't have composer installed already.

Once composer is installed, simply execute this command from the shell in your project directory:

Or manually add the package to your composer.json file:

Finally, be sure to include the composer autoloader in your code if your framework doesn't already do this for you:

Git

Execute the following git command from the shell in your project directory:

When git is done cloning, include the file containing the class like so in your code:

Download the Release

If you prefer not to use composer or git, simply download the package, unpack the zip file, then include the file containing the class in your code like so:

Example usage

A basic example how to use the class:

Please refer to the examples/ directory for some more detailed examples which can be used as a starting point for your own PHP code.

IMPORTANT NOTES:

  1. In the above example, $site_id is the short site "name" (usually 8 characters long) that is visible in the URL when managing the site in the UniFi Network Controller. For example with this URL:

    https://<controller IP address or FQDN>:8443/manage/site/jl3z2shm/dashboard

    jl3z2shm is the short site "name" and the value to assign to $site_id.

  2. The 6th optional parameter that is passed to the constructor in the above example (true), enables validation of the controller's SSL certificate which is otherwise disabled by default. It is highly recommended to enable this feature in production environments where you have a valid SSL cert installed on the UniFi Controller that is associated with the FQDN in the controller_url parameter. This option was added with API client version 1.1.16.

  3. Using an administrator account ($controller_user in the above example) with read-only permissions can limit visibility on certain collection/object properties. See this issue and this issue for an example where the WPA2 password isn't visible for read-only administrator accounts.

Functions/methods supported

The class currently supports the following functions/methods to access the UniFi Controller API. This list is sorted alphabetically. Please refer to the comments in the source code for more details on each of the functions/methods, their purpose, and their respective parameters.

Need help or have suggestions?

There is still work to be done to add functionality and further improve the usability of this class, so all suggestions/comments are welcome. Please use the GitHub Issues section or the Ubiquiti Community forums (https://community.ubnt.com/t5/UniFi-Wireless/PHP-class-to-access-the-UniFi-controller-API-updates-and/td-p/1512870) to share your suggestions and questions.

IMPORTANT NOTE:

When encountering issues with the UniFi API using other libraries, cURL or Postman, please do not open an Issue. Such issues will be closed immediately. Please use the Discussions section instead.

Contribute

If you would like to contribute code (improvements), please open an issue and include your code there or else create a pull request.

Credits

This class is based on the initial work by the following developers:

and the API as published by Ubiquiti:

Important Disclaimer

Many of the functions in this API client class are not officially supported by Ubiquiti and as such, may not be supported in future versions of the UniFi Controller API.

All versions of unifi-api-client with dependencies

PHP Build Version
Package Version
Requires php Version >=7.4.0
ext-curl Version *
ext-json Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package art-of-wifi/unifi-api-client contains the following files

Loading the files please wait ....