https://github.com/hjdhjd/unifi-access

A nearly complete implementation of the UniFi Access API.
https://github.com/hjdhjd/unifi-access

Last synced: 2 months ago
JSON representation

A nearly complete implementation of the UniFi Access API.

• Host: GitHub
• URL: https://github.com/hjdhjd/unifi-access
• Owner: hjdhjd
• License: other
• Created: 2024-03-02T06:39:21.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-03-31T17:15:40.000Z (9 months ago)
• Last Synced: 2024-04-26T10:29:22.183Z (8 months ago)
• Language: TypeScript
• Size: 214 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        




[![unifi-access: UniFi Access API](https://raw.githubusercontent.com/hjdhjd/unifi-access/main/unifi-access.svg)](https://github.com/hjdhjd/unifi-access)

# UniFi Access API

[![Downloads](https://img.shields.io/npm/dt/unifi-access?color=%230559C9&logo=icloud&logoColor=%23FFFFFF&style=for-the-badge)](https://www.npmjs.com/package/unifi-access)

[![Version](https://img.shields.io/npm/v/unifi-access?color=%230559C9&label=UniFi%20Access%20API&logo=ubiquiti&logoColor=%23FFFFFF&style=for-the-badge)](https://www.npmjs.com/package/unifi-access)

## Aspiring to a complete UniFi Access API implementation.





`unifi-access` is a library that enabled you to connect to and communicate with the Ubiquiti UniFi Access API and ecosystem. [UniFi Access](https://ui.com/door-access) is [Ubiquiti's](https://www.ui.com) enterprise and small business solution for door access with a variety of controller hardware options, locks, and readers for you to choose from, as well as an app which you can use to view, configure and manage your setup.

## Why use this library for UniFi Access support?

UniFi has published an API to support UniFi Access. This library's goal is to make the native UniFi Access API available as well as the more limited API that's officially supported by Ubiquiti to provide a robust library.

### How you can contribute and make this library even better

This implementation is in its infancy. I welcome inputs and perspective, particularly as I pursue a path to implement both the native Access API and the published one by Ubiquiti.

### Features

- Native UniFi Access support.

## Changelog

* [Changelog](https://github.com/hjdhjd/unifi-access/blob/main/docs/Changelog.md): changes and release history of this library.

## Installation

To use this library in Node, install it from the command line:

```sh

npm install unifi-access

```

## Documentation

Documentation and examples for using this library to access UniFi Access controllers is [available here](https://github.com/hjdhjd/unifi-access/blob/main/docs/classes/AccessApi.md).

## Library Development Dashboard

This is mostly of interest to the true developer nerds amongst us.

[![License](https://img.shields.io/npm/l/unifi-access?color=%230559C9&logo=open%20source%20initiative&logoColor=%23FFFFFF&style=for-the-badge)](https://github.com/hjdhjd/unifi-access/blob/main/LICENSE.md)

[![Build Status](https://img.shields.io/github/workflow/status/hjdhjd/unifi-access/Continuous%20Integration?color=%230559C9&logo=github-actions&logoColor=%23FFFFFF&style=for-the-badge)](https://github.com/hjdhjd/unifi-access/actions?query=workflow%3A%22Continuous+Integration%22)

[![Dependencies](https://img.shields.io/librariesio/release/npm/unifi-access?color=%230559C9&logo=dependabot&style=for-the-badge)](https://libraries.io/npm/uniti-access)

[![GitHub commits since latest release (by SemVer)](https://img.shields.io/github/commits-since/hjdhjd/unifi-access/latest?color=%230559C9&logo=github&sort=semver&style=for-the-badge)](https://github.com/hjdhjd/unifi-access/commits/main)