README

简单且PSR7兼容的WHMCS API客户端，灵感来自GitLabPHP/Client。

安装

Composer

$ composer require "darthsoup/php-whmcs-api" "guzzlehttp/guzzle:^7.5" "http-interop/http-factory-guzzle:^1.2"

系统需求

此包需要

PHP ^7.4 | ^8.0
PHP扩展 curl、json 和 mbstring

使用

初始化客户端

客户端的基本初始化。

<?php
require_once __DIR__ . '/vendor/autoload.php';

$client = new \DarthSoup\WhmcsApi\Client();

// Auth Credentials with identifier and secret
$client->authenticate('your_identifier', 'your_secret', \DarthSoup\WhmcsApi\Client::AUTH_API_CREDENTIALS);

// Login Credentials with Username and Password (without md5)
$client->authenticate('your_username', 'your_password', \DarthSoup\WhmcsApi\Client::AUTH_LOGIN_CREDENTIALS);

// Set the URL to your whmcs instance
$client->url('http://<your_whmcs_instance_url>');

API访问密钥

如果你的实例在whmcs的configuration.php中配置了额外的$api_access_key，你也可以在初始化过程中使用accessKey来添加它。

$client->accessKey('my_access_key');

端点

示例

获取客户

$client->client()->getClients(['search' => 'firstname']);

获取所有订单

$client->orders()->getOrders();

调用自定义API路由

如果你的WHMCS实例包含自定义API路由，你也可以不扩展代码来调用它们。

$parameters = ['foo' => 'bar'];
$client->custom()->yourCustomApiName($parameters);

文件示例

如果阅读文档不是你的强项，在/examples文件夹中也有一些示例。

免责声明

如果你使用此客户端，请参考WHMCS开发者页面上的文档。API文档在某些地方非常不完整，在某些情况下文档质量存疑。

支持

请在github上创建一个问题

许可证

此包在MIT许可证下发布。有关详细信息，请参阅附带的LICENSE文件。

darthsoup / php-whmcs-api

维护者

详情