Skip to content

SDK en PHP para consumir servicios del sitio Buda.com

License

Notifications You must be signed in to change notification settings

tsukiro/buda-sdk

Repository files navigation

Contributors Forks Stargazers Issues MIT License PHP Composer

Description

Este proyecto tiene como finalidad generar un SDK en PHP para utilizar los endpoints del sitio Buda.com Por ahora el proyecto está generado con el Codegen de Tsukiro que podrá ser cambiado en un futuro Release.

Requirements

PHP 5.5 and later

Installation & Usage

Composer

Puedes instalar el proyecto utilizando composer (v2)

Puedes añadir la siguiente linea de comandos a tu composer.json:

{
  "require": {
    "tsukiro/buda-sdk": "*@dev"
  }
}

Luego ejecuta composer install

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Luego de haber seguido los pasos del procedimiento de instalación puedes hacer lo suguiente:

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

$apiInstance = new Tsukiro\Client\Api\BudaApi();

try {
    $apiInstance->setApiKey("YOUR_APIKEY");
    $apiInstance->setSecret("YOUR_SECRET");
    $response =  $apiInstance->getBalance();
    list($body, $statusCode, $headers) = $response;

} catch (Exception $e) {
    echo 'Exception when calling BudaApi->apiV2BalancesGet: ', $e->getMessage(), PHP_EOL;
}

$apiInstance = new Tsukiro\Client\Api\BudaApi();

try {
    $response = $apiInstance->getMarkets();
    list($markets, $statusCode, $headers) = $response;
} catch (Exception $e) {
    echo 'Exception when calling BudaApi->getMarkets: ', $e->getMessage(), PHP_EOL;
}

$apiInstance = new Tsukiro\Client\Api\BudaApi();
$market_id = "market_id_example"; // string | Market ID obtenido desde le metodo getMarkets o desde tu base de datos

try {
    $response = $apiInstance->getTicker($market_id);
    list($ticker, $statusCode, $headers) = $response;
} catch (Exception $e) {
    echo 'Exception when calling BudaApi->apiV2MarketsMarketIdTickerGet: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

All URIs are relative to https://www.buda.com

Class Method HTTP request Description
BudaApi getBalances GET /api/v2/balances
BudaApi getMarkets GET /api/v2/markets
BudaApi getTicker GET /api/v2/markets/{market_id}/ticker

Documentation For Authorization

Para las rutas que requieran autenticación como lo es getBalances debes setear tu apikey y tu secret, las funciones que se hayan desarrollado automáticamente generarán el nonce y signature necesarios para comunicarse con los endpoints de buda

    $apiInstance->setApiKey("YOUR_APIKEY");
    $apiInstance->setSecret("YOUR_SECRET");