README

使用此 PHP 库管理您的 WHM/cPanel 服务器。简单易用。使用此 PHP 库，您可以管理您的 cPanel/WHM 服务器。

安装

您可以使用 composer 安装此库。

composer require musoftware/cpanel-whm-api:dev-master

用法

<?php
require "vendor/autoload.php";

//Build WHM Client
use PreviewTechs\cPanelWHM\WHM\Accounts;
use PreviewTechs\cPanelWHM\WHMClient;

require "vendor/autoload.php";
$whmClient = new WHMClient("WHM_USERNAME","API_TOKEN", "yourwhmserver.com", 2087);
$accounts = new Accounts($whmClient);

var_dump($accounts->searchAccounts());

WHM 客户端

要访问和使用 WHM 相关功能，您必须构建配置和凭据的 WHM 客户端。

要配置您的 WHM 客户端，您必须提供您的 WHM 用户名（您用于登录 WHM 控制面板的）和 API 令牌。

如果您有一个 API 令牌，您可以使用它，如果适当的权限已配置，否则您可以从 WHM 中创建一个新的 API 令牌。

从 https://your-whm-server:2087/cpsessxxxxxx/scripts7/apitokens/home 创建 API 令牌

有关 WHM API 令牌的更多信息，请参阅 https://documentation.cpanel.net/display/64Docs/Manage+API+Tokens

<?php
use PreviewTechs\cPanelWHM\WHMClient;
$whmClient = new WHMClient("WHM_USERNAME","API_TOKEN", "yourwhmserver.com", 2087);

可用功能

WHM
- 账户
  - searchAccounts (所有账户列表)
  - getDetails (特定账户的详细信息)
  - create (创建新账户)
  - availableFunctions (当前认证用户可用的 API 函数列表)
  - userDomainDetails (获取托管域名详细信息)
  - changeDiskSpaceQuota (修改用户的磁盘空间配额)
  - forcePasswordChange (强制用户在下次登录时更改密码)
  - getDomains (服务器中存在的域名列表)
  - hasDigestAuth (摘要认证已启用或禁用)
  - hasMyCnfInHomeDirectory (.my.cnf 文件是否存在于用户的家目录中)
  - limitBandwidth (修改带宽限制)
  - getUsers (服务器中所有用户的列表)
  - getLockedAccounts (所有锁定账户的列表)
  - getSuspendedAccounts (所有已挂起账户的列表)
  - createUserSession()
  - changePlan()

贡献

您始终欢迎为此库做出贡献。

查看我们的贡献者列表

问题/错误报告

请在 GitHub 仓库中创建问题或报告错误，我们将很高兴调查。

许可

MIT 许可证 (MIT)

特此授予任何获得此软件及其相关文档文件（“软件”）副本的任何人无限制地处理软件的权利，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本，并允许向提供软件的个人提供如此授权，前提是以下条件：

musoftware / cpanel-whm-api

维护者

详细信息

README

安装

用法

WHM 客户端

可用功能

贡献

问题/错误报告

许可