README

这是一个用于使用MyOwnFreeHost免费托管系统的API客户端。

重要提示：此库面向有经验的PHP开发者。需要具备面向对象PHP和Composer的使用经验。如果您无法使用面向对象的PHP和Composer，请勿使用此库。

安装

此软件包最好通过Composer安装

composer require infinityfree/mofh-client

使用方法

在开始之前，您需要从MyOwnFreeHost获取API凭据。登录到经销商面板，转到API -> 设置WHM API -> 选择您要配置的域名。复制API用户名和密码，并将您自己的IP地址设置为允许的IP地址（您的计算机、服务器或您想使用此API客户端的任何地方）。

可用方法

MyOwnFreeHost API公开以下方法。以下列出了可用参数。

• createAccount: 创建新的托管帐户。
  • username: 帐户的唯一、8个字符标识符。
  • password: 登录控制面板、FTP和数据库的密码。
  • domain: 要创建帐户的域名。可以是子域名或自定义域名。
  • email: 用户的电子邮件地址。
  • plan: 要创建帐户的托管计划名称。需要通过MyOwnFreeHost配置托管包。
• suspend: 暂停托管帐户。
  • username: 帐户的唯一、8个字符标识符。
  • reason: 关于您为何暂停帐户的信息字符串。
  • linked: 如果为true，相关的帐户也将被暂停。
• unsuspend: 重新激活托管帐户。
  • username: 帐户的唯一、8个字符标识符。
• password: 更改托管帐户的密码。
  • username: 帐户的唯一、8个字符标识符。
  • password: 为帐户设置的新密码。
• availability: 检查给定的域名是否可用于添加到帐户。
  • domain: 要检查的域名或子域名。
• getUserDomains: 获取与给定帐户链接的域名。
  • username: VistaPanel登录用户名（例如：abcd_12345678）。
• getDomainUser: 获取特定托管域名的信息，包括其托管帐户和文档根目录。
  • domain: 要搜索的域名。
• getCname: 获取域名的CNAME子域名，用于CNAME域名验证。
  • username: VistaPanel登录用户名（例如：abcd_12345678）。
  • domain: 要生成CNAME子域名的域名。

示例

use \InfinityFree\MofhClient\Client;

// Create a new API client with your API credentials.
$client = new Client("<MOFH API username>", "<MOFH API password>");

// Create a new hosting account.
$createResponse = $client->createAccount(
    'abcd1234', // A unique, 8 character identifier of the account. Primarily used as internal identifier.
    'password123', // A password to login to the control panel, FTP and databases.
    'user@example.com', // The email address of the user.
    'userdomain.example.com', // Initial domain of the account. Can be a subdomain or a custom domain.
    'my_plan', // The hosting plan name at MyOwnFreeHost.
);

// Check whether the request was successful.
if ($createResponse->isSuccessful()) {
    echo "Created account with username: ".$createResponse->getVpUsername();
} else {
   echo 'Failed to create account: ' . $createResponse->getMessage();
   die();
}

许可证

版权所有 © 2023 InfinityFree

遵循Apache License 2.0（“许可证”）；除非您遵守本许可证，否则不得使用此文件。您可以在以下位置获取许可证副本：

https://apache.ac.cn/licenses/LICENSE-2.0

除非适用法律要求或经书面同意，否则在本许可证下分发的软件按“原样”基础分发，不提供任何明示或暗示的保证或条件。有关许可权限和限制的具体语言，请参阅许可证。