README

用于与 aaPanel API 交互的 PHP 客户端库。

功能

• 从 API 获取日志。
• 添加新网站。
• 添加子域名。
• 删除子域名。
• 获取 FTP 账户列表。
• 添加新的 FTP 账户。
• 删除 FTP 账户。
• 将 SQL 文件导入数据库。
• 将文件内容保存到指定路径。
• 将 ZIP 存档解压到指定位置。
• 将 SSL 证书应用于域名。
• 为域名续订 SSL 证书。
• 获取域名的 SSL 详细信息并返回 'index' 值。
• 为网站启用 HTTPS 转发。
• 禁用网站。
• 启用网站。
• 检索特定 FTP 账户的详细信息。
• 设置服务器配置参数。
• 获取服务器配置参数。

安装

使用 Composer 安装库

composer require azozzalfiras/aapanel-api

用法

初始化客户端

require_once 'vendor/autoload.php';

use aaPanelApiClient;

$apiKey = 'your_api_key'; // get the api key from the settings aapanle
$baseUrl = 'https://example.com:8888'; // Replace with your aaPanel API base URL
$client = new aaPanelApiClient($apiKey, $baseUrl);

功能

获取日志

从 API 获取日志。

$logs = $client->fetchLogs();
var_dump($logs);

添加新网站

将新网站添加到 aaPanel。

$response = $client->addSite('example.com', 'example', 'Example site');
var_dump($response);

添加子域名

将子域名添加到现有域名。

$response = $client->addSubdomain('subdomain', 'example.com', '192.168.1.1');
var_dump($response);

删除子域名

从现有域名中删除子域名。

$response = $client->deleteSubdomain('subdomain', 'example.com', '192.168.1.1');
var_dump($response);

获取 FTP 账户

获取 FTP 账户列表。

$ftpAccounts = $client->fetchFtpAccounts();
var_dump($ftpAccounts);

添加 FTP 账户

添加新的 FTP 账户。

$response = $client->addFtpAccount('ftpuser', 'ftppassword');
var_dump($response);

删除 FTP 账户

删除 FTP 账户。

$response = $client->deleteFtpAccount('ftpuser');
var_dump($response);

导入 SQL 文件

将 SQL 文件导入数据库。

$response = $client->importSqlFile('/path/to/example.sql', 'example_database');
var_dump($response);

保存文件

将文件内容保存到指定路径。

$fileContent = 'Hello, world!';
$response = $client->saveFile($fileContent, '/path/to/file.txt');
var_dump($response);

解压文件

将 ZIP 存档解压到指定位置。

$response = $client->unzipFile('/path/to/example.zip', '/path/to/extracted', 'zip_password');
var_dump($response);

应用 SSL 证书

将 SSL 证书应用于域名。

$response = $client->applySslCertificate('example.com', 1, 0);
var_dump($response);

续订 SSL 证书

为域名续订 SSL 证书。

$response = $client->renewCert('example.com');
var_dump($response);

获取 SSL 详细信息

获取域名的 SSL 详细信息。

$index = $client->getIndexValue('example.com');
var_dump($index);

启用 HTTPS 转发

为网站启用 HTTPS 转发。

$response = $client->enableHttpsRedirection('example.com');
var_dump($response);

禁用网站

禁用网站。

$response = $client->disableSite(1, 'example.com');
var_dump($response);

启用网站

启用网站。

$response = $client->enableSite(1, 'example.com');
var_dump($response);

获取 FTP 账户详细信息

检索特定 FTP 账户的详细信息。

$details = $client->getFtpAccountDetails('ftpuser');
var_dump($details);

设置服务器配置

设置服务器配置参数。

$config = [
    'param1' => 'value1',
    'param2' => 'value2'
];
$response = $client->setServerConfig($config);
var_dump($response);

获取服务器配置

获取服务器配置参数。

$config = $client->getServerConfig();
var_dump($config);

许可证

本项目采用 MIT 许可证 - 有关详细信息，请参阅 LICENSE 文件。

MIT 许可证

版权所有 (c) 2024 Azozz ALFiras

特此授予任何人免费获得此软件及其相关文档文件（以下简称“软件”）副本的权利，用于在不作限制的情况下处理软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本，并允许向软件提供方提供软件的人这样做，前提是遵守以下条件

上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。

软件按“原样”提供，不提供任何明示或暗示的保证，包括但不限于对适销性、特定用途的适用性和非侵权的保证。在任何情况下，作者或版权所有者均不对任何索赔、损害或其他责任承担责任，无论该责任基于合同、侵权或其他原因，以及与软件或软件的使用或任何其他交易有关。