Unifi Access API Protobuf Definitions

Version: V2.2.10

Documentation: https://core-config-gfoz.uid.alpha.ui.com/configs/unifi-access/api_reference.pdf

Overview

This repository provides protobuf definitions for the Ubiquiti Access API, allowing developers to generate client libraries, validate messages, and define services for integration with Ubiquiti Access systems. These definitions are intended for use in creating message and service definitions, and are not tied to any specific server implementation.

Note:

• Section 11 on Webhooks was omitted.

Disclaimer

This is unofficial API documentation for the Ubiquiti Access API. It is provided as-is without any guarantees of accuracy or completeness. Use at your own risk.

API Documentation

View API Documentation

Getting Started

1. Clone the Repository

git clone https://github.com/luis-godinez/unifi-access-api.git

2. Clone the Google Proto Repo

Note: The repo may be cloned within the api repo itself, but you'll need to change the dependecy path in npm script path.

git clone https://github.com/googleapis/api-common-protos.git

unifi-access-api/package.json

Default (outside repo)

"generate:js": "npm run clean && protoc -I=./proto -I=../api-common-protos --js_out=import_style=commonjs,binary:dist ../proto/*.proto ../api-common-protos/google/api/*.proto",

Custom (inside repo):

"generate:js": "npm run clean && protoc -I=./proto -I=../api-common-protos --js_out=import_style=commonjs,binary:dist ./proto/*.proto ../api-common-protos/google/api/*.proto",

3. Install Dependencies

cd unifi-access-api
npm install

4. Generate Code

Javascript: npm run generate:js

Typescript: npm run generate:ts

Python: npm run generate:python

5. Use in your project

Javascript(commonJS):
const { Visitor } = require('../path/to/generated/dist/visitor_pb.js');

Javascript(ES6):
import { Visitor } from '../path/to/generated/dist/visitor_pb.js';

Typescript:
import { Visitor } from '../path/to/generated/dist/visitor_pb';

Python:
from path.to.generated.dist import visitor_pb2

Contribution:

If you'd like to contribute to this project due to any API changes or issues, please ensure to:

• update the README documentation w/ latest API version
• re-generate the API documentation

Generate documentation from proto definition

go install github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@latest
npm run generate:html