README

Volabit的PHP API库。轻松将Volabit服务集成到您的应用程序中。

您可以在项目维基中查看可用的方法。API使用详情可以在官方网站找到。

安装

使用Composer

$ composer require volabit/client

然后，您可能需要要求自动加载脚本并在代码中使用Volabit命名空间

require 'vendor/autoload.php'

use Volabit\Client\OAuth2Client as VolabitClient;

用法

1. 实例化一个新的Volabit客户端对象。

$app_id   = 'The registered API for your APP.';
$secret   = 'The registered secret for your APP.';
$callback = 'The registered callback URL for your APP';

$volabitClient = new VolabitClient($app_id, $secret, $callback);

注意，默认情况下，Volabit客户端使用的是生产环境。如果您想使用测试环境，在请求授权代码之前将sandbox标志设置为true。

$volabitClient->sandbox(true);

1. 获取允许用户授权您的应用程序使用其账户的URL。（应该在浏览器中打开。）

$auth_url = $volabitClient->authorize();

1. 在您获得授权代码（发送到您提供的回调URL）后，您将使用它来获取刷新和访问令牌。此代码只能使用一次，因此请确保存储令牌对象以供以后使用，否则您的应用程序将需要重新授权。

$volabitClient->getTokens('The given authorization code.');

或者，您可以从数组中加载先前获得的令牌

$tokens = [
  'access_token' => 'an access token',
  'refresh_token' => 'a refresh token',
  'expires_in' => 'expiration time (unix time format)'
];

$volabitClient->useTokens($tokens);

1. 有了这些令牌，您就准备好调用服务了。方法将返回一个响应数组。

$response = $volabitClient->tickers();
print_r($response);
// Array
// (
//    [btc_usd_buy] => 236.42
//    [btc_usd_sell] => 236.51
//    [usd_mxn_buy] => 14.59
//    [usd_mxn_sell] => 15.19
//    [btc_mxn_buy] => 3450.44
//    [btc_mxn_sell] => 3592.64
// )

注意：如果您从API收到未授权错误响应，请尝试重新授权您的应用程序并获取新的令牌。

您可以在客户端的对应部分查看可用的方法源代码。API使用详情可以在官方网站找到。

贡献

1. 分叉它（https://github.com/[my-github-username]/php-api-client/fork）
2. 创建您的功能分支（git checkout -b my-new-feature）
3. 提交您的更改（git commit -am 'Add some feature'）
4. 推送到分支（git push origin my-new-feature）
5. 创建一个新的Pull Request