emad-mohammed/whm-api

WHM & Cpanel API with PHP

v1.0.0 2023-06-10 22:47 UTC

This package is not auto-updated.

Last update: 2024-09-30 03:48:28 UTC


README

使用PHP通过API执行WHM和Cpanel操作

安装

使用以下命令安装最新版本

$ composer require  emad-mohammed/whm-api

需求

  • 需要PHP 7.0或更高版本

目前支持的操作

  • WHM
    • 账户
      • 获取所有Cpanel账户
      • 创建新的Cpanel用户
      • 删除Cpanel用户
      • 获取被暂停的Cpanel用户
      • 暂停Cpanel用户
      • 取消暂停Cpanel用户
    • 服务
      • 重启服务
      • 启用服务
      • 禁用服务
      • 获取服务状态
      • 获取服务配置
    • 邮件
      • 获取Cpanel用户的电子邮件账户
  • Cpanel
    • 目前不支持的操作

基本用法

// All API Calls made throw HTTPS 
use \EmadMohammed\WHMAPI\base\WHMClient ;
$ipOrDomain = "YOUR_IP_OR_DOMAIN"; // IP is preferred , we take care of get Domain
$user  = 'root' ; //  for example
$token = "YOUR_TOKEN" ; //
$whmClient = new WHMClient($ipOrDomain , $user , $token);

//--------- Accounts ---------//

// get All Cpanel users
var_dump($whmClient->accountsManagementInstance()->all());

// Create Cpanel users
$diskSizeInMegaBytes = 500; // Default unlimited
var_dump ($whmClient->accountsManagementInstance()->create("USER_NAME" , "PASSWORD" , $diskSizeInMegaBytes));
 
// get All suspended Cpanel users
var_dump ($whmClient->accountsManagementInstance()->suspensions());

// suspend Cpanel user
var_dump ($whmClient->accountsManagementInstance()->suspendCpanelUser("CPANEL_USER_NAME"));

// suspend Cpanel users
var_dump ($whmClient->accountsManagementInstance()->unsuspendCpanelUser("CPANEL_USER_NAME"));

// delete Cpanel users
var_dump ($whmClient->accountsManagementInstance()->delete("CPANEL_USER_NAME"));

//----------- Services -----------//

/**
*  EmadMohammed\WHMAPI\whm\services\Services class contain some service name , You can use it or pass service's Name 
 */

// restart service
var_dump ($whmClient->servicesManagementInstance()->restartService(\EmadMohammed\WHMAPI\whm\services\Services::HTTP));

// Disable Service
var_dump ($whmClient->servicesManagementInstance()->disableService(\EmadMohammed\WHMAPI\whm\services\Services::FTP));

// Enable Service
var_dump ($whmClient->servicesManagementInstance()->enableService(\EmadMohammed\WHMAPI\whm\services\Services::FTP));

// Get Service Config
var_dump ($whmClient->servicesManagementInstance()->getServiceConfig(\EmadMohammed\WHMAPI\whm\services\Services::FTP));

// Get Service Status
var_dump ($whmClient->servicesManagementInstance()->getServiceStatus(\EmadMohammed\WHMAPI\whm\services\Services::FTP));

//------- Mail --------//

// Get email accounts of Cpanel user
var_dump ($whmClient->mailManagementInstance()->getEmailAccountsOfCpanelUser("CPANEL_USER_NAME"));

注意

如果您需要任何不存在的操作,欢迎订购。
联系我:
  电子邮件: admin@omdda.com
  whatsapp: +966500444298

许可证

emad-mohammed/whm-api遵循MIT许可证。