README

这是一个Combell共享托管API客户端实现。目标是提供一个客户端库，使您能够轻松地与Combell共享托管公共API交互。

当前状态

由于Combell API仍在开发中，并且定期添加新功能，这个库可能尚未实现每个调用。我们尽量保持其尽可能的最新。我们关注Combell API变更日志，但如果缺少调用，请通过打开问题或更好的是提交一个拉取请求来通知我们；)

用法

您可以通过composer安装此库

composer install tomcan/combell-api

接下来，您需要包含composer自动加载器。使用您的API密钥和密钥实例化API对象，创建命令对象并发送它们！

require __DIR__ . '/vendor/autoload.php';

$key = 'YOUR-API-KEY';  
$sec = 'YOUR-API-SECRET';

$api = new \TomCan\CombellApi\Common\Api(
    new \TomCan\CombellApi\Adapter\GuzzleAdapter(),
    new \TomCan\CombellApi\Common\HmacGenerator($key, $sec)
);
$cmd = new \TomCan\CombellApi\Command\Accounts\ListAccounts();
  
var_dump($api->executeCommand($cmd));

命令将返回调用的数据，例如上面是一个包含Account对象的数组。请参阅测试目录以获取所有调用的大量示例。

如果您需要有关HTTP调用的信息，可以询问API对象

// return the HTTP status code. 200 -> 204 indicate success, other codes typically mean failure of some sort
$api->getStatusCode();

// rate limiting headers
$api->getRateLimitUsage();
$api->getRateLimitRemaining();
$api->getRateLimitReset();
$api->getRateLimitLimit();

如果命令是分页的，您可以从命令对象获取分页信息

$cmd->getPagingSkipped();
$cmd->getPagingTake();
$cmd->getPagingTotalResults();

tomcan / combell-api

维护者

详情

README

当前状态

用法