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

On this page you can find all versions of the php package art-of-wifi/unifi-cloud-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-cloud-api-client

Informations about the package unifi-cloud-api-client

API client class for Official UniFi Cloud API

A PHP class that provides access to Ubiquiti's official UniFi Cloud API for their Site Manager platform.

Introduction

This client provides a modern and convenient way to interact with the official UniFi Cloud API using PHP. It uses Guzzle for HTTP requests and supports various operations to interact with UniFi deployments programmatically.

This client supports the official UniFi Cloud API up to version 0.1.

Important Note

This is not a replacement for our original API Client which offers more functions and endpoints, but does not support connections through unifi.ui.com: https://github.com/Art-of-WiFi/UniFi-API-client

Requirements

Installation

The package needs to be installed using Composer/packagist for easy inclusion in your projects by executing the following command from your project directory:

Follow these installation instructions if you don't have Composer installed already.

Developer Documentation

Usage

Below is a basic example of how to use the UniFi Cloud API Client:

Getter and Setter Methods

There are several getter and setter methods available to interact with the UniFi Cloud API client:

Method Description
setTimeout($timeout) Sets the timeout for the HTTP requests in seconds, default is 10 seconds.
getTimeout() Returns the timeout for the HTTP requests in seconds.
setDebug($debug) Enables or disables debug mode, false by default.
getDebug() Returns the debug mode status.
getVersion() Returns the version of the UniFi Cloud API client.
getEffectiveUri() Returns the effective URI of the last request.
getTransferTime() Returns the transfer time of the last request in seconds.
getResponseStatusCode() Returns the response status code of the last request.
getHandlerStats() Returns the Guzzle handler statistics of the last request.
getHandlerErrorData() Returns the Guzzle handler errors of the last request.

API Reference

List Hosts

API Route

GET /ea/hosts

Description

Retrieve a list of all hosts associated with the UI account making the API call.

Usage

Example Response

Get Host by ID

API Route

GET /ea/hosts/{id}

Description

Retrieve detailed information about a specific host by ID.

Usage

Example Response

List Sites

API Route

GET /ea/sites

Description

List sites associated with the UI account making the API call.

Usage

Example Response

List Devices

API Route

GET /ea/devices

Description

List UniFi devices that are associated with the UI account making the API call, grouped by host.

Usage

Parameters

Example Response

Rate Limiting

The API rate limit is set to 100 requests per minute. If you exceed this limit, the server will respond with a 429 Too Many Requests status code. The client will throw an Exception if this happens.

Important note on general API support

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

Contribute

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

Credits

This class is based on the documentation provided by Ubiquiti for their UniFi Cloud API: https://developer.ui.com/unifi-api/

Important Disclaimer

This PHP class is provided "as is" without any guarantees or warranties. Use at your own risk. The author is not responsible for any damage or losses of any kind caused by the use or misuse of this class.

All versions of unifi-cloud-api-client with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
ext-curl Version *
guzzlehttp/guzzle Version ^7.0
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-cloud-api-client contains the following files

Loading the files please wait ....