volabit/client

Library for the Volabit API.

Maintainers

Details

github.com/coincovemx/php-api-client

Source

Issues

Installs: 19

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 10

Forks: 0

Open Issues: 0

v1.0.2 2015-04-01 17:14 UTC

Requires

Requires (Dev)

MIT 73a3e71b2523218c77fac61e4f78ba0a56a31da3

paymentsbitcoinvolabit

This package is not auto-updated.

Last update: 2024-11-09 17:50:48 UTC

README

Volabit's API library for PHP. Integrate the Volabit services in your apps with ease.

You can see the available methods on the project wiki. Details of the API use can be found on the official page.

Installation

Using Composer:

$ composer require volabit/client

Then, you may require the autoload script and use the Volabit namespace in your code:

require 'vendor/autoload.php'

use Volabit\Client\OAuth2Client as VolabitClient;

Usage

  1. Instance a new Volabit client object.
$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);

Note that the by default the Volabit client uses the production environment. If you want to use the test environment, set the sandbox flag to true before requesting the authorization code.

$volabitClient->sandbox(true);
  1. Get the URL that will allow the user to authorize your app to use his/her account. (It should be opened in a browser.)
$auth_url = $volabitClient->authorize();
  1. After you get the authorization code (sent at the callback URL that you provided), you'll use it to get the refresh and access tokens. This code can be used only once, so be sure to store the token object for later use or your app will have to be reauthorized.
$volabitClient->getTokens('The given authorization code.');

Or, you can load previously obtained tokens from an array:

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

$volabitClient->useTokens($tokens);
  1. With these tokens, you'll be ready to call the services. The methods will return a response array.
$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
// )

Note: If you get unauthorized error responses from the API, try to reauthorize your application and get new tokens.

You can see the available methods source on the corresponding section of the client. Details of the API use can be found on the official page.

Contributing

  1. Fork it ( https://github.com/[my-github-username]/php-api-client/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Bitdeli Badge