README

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

这是对PreviewTechnologies/cpanel-whm-api的分支。计划是将其现代化，并随着时间的推移逐步扩展功能以更好地适应Laravel项目。

安装

您可以使用composer安装此库。

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

使用

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

//Build WHM Client
use lukehebb\cPanelWHM\WHM\Accounts;
use lukehebb\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 lukehebb\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

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

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

本软件按“现状”提供，不提供任何明示或暗示的保证，包括但不限于对适销性、针对特定目的的适用性和非侵权的保证。在任何情况下，作者或版权所有者均不对任何索赔、损害或其他责任负责，无论该责任是基于合同、侵权或其他方式，无论该责任是否与软件或其使用或其他方式有关。