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

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

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

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