README

使用这个 PHP 库来管理您的 WHM/cPanel 服务器。简单易用。通过这个 PHP 库，您可以管理您的 cPanel/WHM 服务器。

安装

您可以使用 composer 安装此库。

composer require previewtechs/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)

版权所有 (c) 2014 域名分销商 API

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

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

本软件按“原样”提供，不提供任何明示或暗示的保证，包括但不限于适销性、适用于特定目的和无侵权性保证。在任何情况下，作者或版权所有者均不对任何索赔、损害或其他责任负责，无论此类索赔、损害或其他责任是基于合同、侵权或其他方式，源于、因之而发生或与此类软件或软件的使用或其他交易有关。