petebishwhip / whmcsapi
此包已被废弃,不再维护。未建议替代包。
此项目很简单。它是一个 WHMCS API 函数的对象库。
1.0.0-alpha.2
2020-03-09 19:50 UTC
Requires
- guzzlehttp/guzzle: ~6.0
Requires (Dev)
This package is auto-updated.
Last update: 2022-11-28 01:17:52 UTC
README
此项目很简单。它是一个 WHMCS API 函数的对象库。使用此包装器很简单。
需求
- PHP 7.3(可能适用于较低版本。由于开发依赖,我只在 PHP 7.3 上进行测试)
- Composer
- WHMCS 安装(及许可证!)- 在此购买
用法
首先,导入库。由于 WHMCSAPI 目前处于 alpha/beta 状态,将最低版本设置为 1.0@alpha
composer require PeteBishwhip/WHMCSAPI:"^1.0@alpha"
导入库后,通过提供三个值来初始化包装器。
变量 | 描述 |
---|---|
$apiIdentifier | 您的 API 标识符 |
$apiSecret | 您的 API 密钥 |
$whmcsUrl | 您的 WHMCS URL(例如 https://example.com/whmcs/) |
use WHMCSAPI\WHMCSAPI; // $whmcsApi = new WHMCSAPI('abc123', '123cba', 'https://example.com/whmcs/'); $whmcsApi = new WHMCSAPI($apiIdentifier, $apiSecret, $whmcsUrl);
初始化库后,使用 command
设置您想要使用的 API 命令
try { $whmcsApi->command('AcceptOrder'); } catch (\WHMCSAPI\Exception\FunctionNotFound $e) { // Perform error handling here // You can retrieve the error with // $e->getMessage(); }
如果命令不可用,将抛出 \WHMCSAPI\Exception\FunctionNotFound
异常,以便捕获错误。如果您想在同一个 try/catch 中执行所有操作,请捕获 WHMCSAPI\Exception\Exception
。所有异常都从此扩展。
从那里,您可以设置 WHMCS 开发文档中记录的任何变量
$whmcsApi->orderid = 25;
准备就绪后,您最终可以执行命令
$result = $whmcsApi->execute();
贡献
请参阅 CONTRIBUTING.md 以获取建议和指导。