UniFi API Client 使用教程

项目介绍

UniFi API Client 是一个用 PHP 编写的 API 客户端类，用于与 Ubiquiti 的 UniFi 控制器 API 进行交互。该项目由 Art of WiFi 维护，支持 UniFi 控制器的多个版本，包括 5.x、6.x、7.x 和 8.x，其中包括版本 8.1.127。自 2017 年 9 月正式发布以来，它已成为最受欢迎的 UniFi 控制器平台 API 客户端，拥有超过 1050 个 GitHub 和 Packagist 星标，以及超过 195,000 次下载或克隆。

项目快速启动

安装

你可以通过 Composer 安装 UniFi API Client：

composer require art-of-wifi/unifi-api-client

或者手动下载并包含在你的项目中：

require_once 'path/to/UniFi-API-client/src/Client.php';

基本使用

以下是一个简单的示例，展示如何连接到 UniFi 控制器并获取站点列表：

require_once 'vendor/autoload.php';

use ArtOfWiFi\UniFiClient\Client;

// 配置连接参数
$controller_url = 'https://127.0.0.1:8443';
$controller_user = 'admin';
$controller_password = 'password';
$site_id = 'default';

// 创建客户端实例
$unifi_client = new Client($controller_url, $controller_user, $controller_password, $site_id, true);

// 获取站点列表
$sites = $unifi_client->list_sites();

print_r($sites);

应用案例和最佳实践

应用案例

1. 设备批量处理：使用 UniFi API Client 可以轻松实现设备的批量添加、修改和删除操作。
2. 自动化报告：通过定期调用 API 获取网络数据，生成自动化报告，帮助网络管理员监控网络状态。
3. 自定义门户解决方案：结合 UniFi API Client 和自定义门户软件，为酒店、企业等提供定制化的网络接入解决方案。

最佳实践

1. 错误处理：在调用 API 时，务必进行错误处理，确保程序的健壮性。
2. 安全考虑：使用 HTTPS 连接，并妥善管理 API 密钥和密码，避免泄露。
3. 性能优化：合理规划 API 调用频率，避免频繁请求导致服务器负载过高。

典型生态项目

1. UniFi API Browser：一个基于 Web 的工具，用于浏览和测试 UniFi 控制器的 API 接口。
2. UniFi NOC Dashboard：一个网络运营中心（NOC）仪表板，通过 UniFi API Client 获取数据，实时监控网络状态。
3. Scheduled Reporting for UniFi：一个定时报告工具，通过 UniFi API Client 定期生成网络使用报告。

通过以上内容，你可以快速了解并开始使用 UniFi API Client，结合实际应用案例和最佳实践，更好地管理和优化你的网络环境。