Download the PHP package uxicodev/unifi-access-api without Composer

On this page you can find all versions of the php package uxicodev/unifi-access-api. 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?

Informations about the package unifi-access-api

A PHP (Laravel) API client for the Ubiquiti Unifi Access API

Latest Version on Packagist Total Downloads Github Actions codecov Static Badge

A GuzzleHTTP client that can communicate with the Ubiquiti Unifi Access API. Ready to use with Laravel, but can also be used with other frameworks or plain PHP. Currently the following Unifi Access resources have been (partially) implemented:

Installation

You can install the package via composer:

Usage

The Unifi Access API exposes several resources. The resources are represented by different Client classes. All resources can be accessed through the UnifiAccessApi\Client\Client class.

All responses are represented by Data Transfer Objects (DTOs) that can be found in the Uxicodev\UnifiAccessApi\API\Responses namespace. The objects returned are Entities that can be found in the Uxicodev\UnifiAccessApi\API\Entities namespace.

Laravel

Add the following to your .env file:

Non-Laravel application

FAQ

My API key is not working

Make sure you are using the correct API key. You can create an API key at two seperate locations, but those locations serve a different purpose. You can retrieve the Access API key in your admin console at page access/settings/system.

You can also create a Network/Protect API key at access/settings/control-plane/integrations. However, this key does NOT work for the Access API.

Testing

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

Laravel Package Boilerplate

This package was generated using the Laravel Package Boilerplate.


All versions of unifi-access-api with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
guzzlehttp/guzzle Version ^7.0
illuminate/support Version ^10.0|^11.0|^12.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 uxicodev/unifi-access-api contains the following files

Loading the files please wait ...