hansadema/whmcs-sdk

WHMCS API 的简单 OOP 封装

0.1.1 2017-03-05 16:39 UTC

This package is auto-updated.

Last update: 2024-09-16 23:37:53 UTC


README

WHMCS API 的简单封装。

安装

此包使用 Composer 安装。您可以使用以下命令将其添加到项目中。

composer require hansadema/whmcs-sdk
composer update

用法

此 API 客户端通过简单的 OOP 封装封装 WHMCS。

首先,您需要使用您的 WMCS 安装详情创建一个客户端实例

$api = new \HansAdema\WhmcsSdk\Client('https://example.com/whmcs/installation/url/', 'myusername', 'mypassword');

注意 URL 末尾的 /。用户名和密码是具有“API 访问”权限的用户的凭证。您可以使用主管理员用户,但出于安全考虑,建议为每个项目创建一个专门的 API 用户。

创建客户端后,您可以开始发送请求。方法对应于 WHMCS API 的动作名称(请参阅 WHMCS API),其他属性可以作为一个数组提交。

例如,要执行“AcceptOrder”动作,您可以使用以下代码。

try {
    $result = $api->acceptOrder([
        'orderid' => 123,
        'serverid' => 456,
        //...
    ]);
} catch (\HansAdema\WhmcsSdk\RequestException $e) {
    echo "Error connecting to WHMCS: ".$e->getMessage();
} catch (\HansAdema\WhmcsSdk\ResponseException $e) {
    echo "There was an issue with your API call: ".$e->getMessage();
}

请注意,这里使用了两种不同类型的异常。当连接到您的 WHMCS 安装存在问题时,例如安装中断或凭证不正确时,将使用 RequestException。当 API 结果不成功时,例如由于缺少或无效的方法参数,将抛出 ResponseException