paydece-sdk-test
v1.0.0
Published
SDK para integrar con la API simplificada de PayDece
Maintainers
Readme
PayDece SDK
SDK para integrar con la API simplificada de PayDece. Este SDK proporciona una interfaz fácil de usar para interactuar con los servicios de PayDece, incluyendo la obtención de órdenes de compra y venta de criptomonedas, verificación de API keys y listados de criptomonedas y monedas fiat disponibles.
Instalación
npm install paydece-sdkUso
import { PayDeceSDK } from 'paydece-sdk';
// Inicializar el SDK
const sdk = new PayDeceSDK({
baseUrl: 'https://v0-dashboard-cueva.vercel.app/',
apiKey: 'tu-api-key'
});
// Obtener órdenes de compra y venta
const orders = await sdk.getOrders({
type: 'both',
fiatCoin: 1, // ARS (Peso Argentino)
crypto: 7, // BTC (Bitcoin)
blockchain: 56 // BNB Chain
});
if (orders.success) {
console.log(`Mejor precio de compra: ${orders.buyPrice} ${orders.buyFiat.symbol}`);
console.log(`Mejor precio de venta: ${orders.sellPrice} ${orders.sellFiat.symbol}`);
console.log(`Spread: ${orders.spread}%`);
console.log(`Cantidad disponible para compra: ${orders.buyAmount} ${orders.buyCrypto.symbol}`);
console.log(`Cantidad disponible para venta: ${orders.sellAmount} ${orders.sellCrypto.symbol}`);
console.log(`Blockchain: ${orders.buyCrypto.blockchain?.description}`);
console.log(`Link para comprar: ${orders.buyLink}`);
console.log(`Link para vender: ${orders.sellLink}`);
// Información del vendedor
console.log(`Vendedor: ${orders.buySeller.username}`);
console.log(`Calificación positiva: ${orders.buySeller.positiveRating}%`);
console.log(`Transacciones totales: ${orders.buySeller.totalTransactions}`);
// Métodos de pago aceptados
console.log('Métodos de pago aceptados:');
orders.buyPaymentMethods.forEach(method => console.log(`- ${method}`));
}
// Verificar API key
const verification = await sdk.verifyApiKey({
apiKey: 'tu-api-key'
});
if (verification.success) {
console.log('API key válida');
console.log('Propietario:', verification.owner);
console.log('Permisos:', verification.permissions.join(', '));
console.log('Creada:', new Date(verification.createdAt).toLocaleDateString());
console.log('Expira:', verification.expiresAt ? new Date(verification.expiresAt).toLocaleDateString() : 'No expira');
}
// Obtener lista de criptomonedas
const cryptoList = await sdk.getCryptoList();
if (cryptoList.success) {
console.log('Criptomonedas disponibles:');
cryptoList.data.forEach(crypto => {
console.log(`ID: ${crypto.cryptoGroupId}, Símbolo: ${crypto.symbol}, Nombre: ${crypto.description}`);
});
}
// Obtener lista de monedas fiat
const fiatList = await sdk.getFiatList();
if (fiatList.success) {
console.log('Monedas fiat disponibles:');
fiatList.data.forEach(fiat => {
console.log(`ID: ${fiat.fiatCoinId}, Símbolo: ${fiat.symbol}, Nombre: ${fiat.description}`);
});
}API
PayDeceSDK
Constructor
new PayDeceSDK(config: SDKConfig)Parámetros:
config.baseUrl: URL base de la API de PayDececonfig.apiKey: Tu API key de PayDece
Métodos
getOrders(params: OrdersParams): Promise
Obtiene las mejores ofertas de compra y venta de criptomonedas.
Parámetros:
params.type: (opcional) Tipo de órdenes ('buy', 'sell' o 'both')params.fiatCoin: ID de la moneda fiat (1: ARS, 2: USD, 3: COP, 5: MXN, 6: BRL, 7: VES, 12: BOB, 13: EUR, 15: UYU, 19: CUSTOM)params.crypto: ID del grupo de criptomonedas (7: BTC, 1: ETH, 2: USDT, etc.)params.blockchain: (opcional) ID de la blockchain (56: BNB Chain, 137: Polygon, 8453: Base, 43114: Avalanche)
verifyApiKey(params: VerifyApiKeyParams): Promise
Verifica si una API key es válida.
Parámetros:
params.apiKey: API key a verificar
getCryptoList(): Promise
Obtiene la lista de criptomonedas disponibles.
getFiatList(): Promise
Obtiene la lista de monedas fiat disponibles.
Desarrollo
Clonar el repositorio:
git clone https://github.com/paydece/paydece-sdk.git cd paydece-sdkInstalar dependencias:
npm installCompilar el proyecto:
npm run buildEjecutar pruebas:
npm test
Licencia
MIT
