jorisvandesande/unifi-api-client

Unifi API Client 可用于连接到您的 Ubiquiti Unifi 控制器的 API

维护者

详细信息

github.com/jorisvandesande/unifi-api-client

主页

源代码

问题

安装: 92

依赖: 0

建议者: 0

安全: 0

星星: 22

关注者: 4

分支: 10

开放问题: 0

dev-master / 1.0.x-dev 2017-11-26 22:42 UTC

Requires

MIT d54f15be2a1eef5a1ae79602c5af4df63a9e0299

apiclientapi clientunifiubiquitiunifi controller

This package is auto-updated.

Last update: 2024-09-29 04:03:19 UTC

README

Unifi API Client 可用于连接到您的 Ubiquiti Unifi 控制器。此客户端基于 Guzzle 构建。

代码已测试与 Unifi 控制器版本 4.6.6 兼容。

安装

API 客户端可以使用 Composer 进行安装。

composer require jorisvandesande/unifi-api-client

或者您可以在以下位置下载最新版本：https://github.com/jorisvandesande/unifi-api-client/releases

用法

use JVDS\UnifiApiClient\Client;
use GuzzleHttp\Client as HttpClient;

$apiClient = new Client(new HttpClient(['base_uri' => 'https://127.0.0.1:8443']));
$apiClient->login('your_username', 'your_password');

// call supported methods via methods on the client
$apiClient->statistics('default');

// or call any API url via the get and post methods:
$apiClient->get('/api/self');
$apiClient->post('/api/s/default/cmd/stamgr', ['cmd' => 'block-sta', 'mac' => '01:01:01:01:01:01']);

// logout
$apiClient->logout();

示例可以在 examples 目录中找到。要运行示例，您必须将 config.example.php 文件复制到 config.php 并根据需要更改配置。

支持的 API 调用

目前客户端中只实现了少数 API 方法。虽然可以使用客户端的 get() 和 post() 方法调用任何 API URL，但目标是支持更多方法。

许可证

MIT 许可证，请参阅 LICENSE 文件。