Dentro del proyecto verás las estructura de carpetas y archivos:
/
├── src/
│ ├── api/
│ │ └── ...
│ ├── helpers/
│ │ └── ...
│ └── interfaces/
│ └── ...
├── test/
│ ├── ...
└── package.json
- Instala el SDK.
npm install qvapay-sdk
o
yarn add qvapay-sdk- Configure en su archivo .env las siguentes variables de entorno:
APP_ID=
APP_SECRET=
EMAIL=
PASSWORD=- Cree un objeto con sus credenciales, incluyendo nombre de usuario y contraseña. Asegúrese de que la contraseña sea segura y no se comparta con nadie:
const userLogin = {
email: process.env.EMAIL,
password: process.env.PASSWORD,
};- Cree un objeto con sus credenciales de Auth para su aplicación:
const appAuth = {
app_id: process.env.APP_ID,
app_secret: process.env.APP_SECRET,
};Ahora que has instalado el SDK y configurado sus opciones primarias, estás listo para comenzar a usar todas las funcionalidades que te ofrece. ¡Aprovecha al máximo todas las posibilidades que este SDK te ofrece!
La sección Auth contiene las funciones login, register y logout. Estas funciones son esenciales para garantizar que solo los usuarios autorizados puedan acceder al contenido y realizar acciones en la aplicación. Todas las funciones son asíncronas y retornan una promesa con la data o el error de la request.
Esta función se encarga de realizar una petición POST a la API de Qvapay para iniciar sesión.
import { login } from 'qvapay-sdk';
const res = await login(userLogin);Esta función se usa para registrar un usuario. Utiliza la API de qvapay para enviar los datos de registro al servidor. Si el registro se realiza correctamente, devuelve los datos recibidos del servidor. Si hay algún error, devuelve el error.
import { register } from 'qvapay-sdk';
const newUser = {
name: 'Juan Perez',
email: '[email protected]',
password: 'CffasdKB73iTtzNJN',
c_password: 'CffasdKB73iTtzNJN',
invite: 'referer_username (OPTIONAL)',
};
const res = await register(newUser);Esta función intenta realizar una solicitud GET a la API qvapay para cerrar la sesión del usuario. Si la solicitud se realiza con éxito, devuelve los datos de respuesta. Si hay algún error, devuelve los datos de respuesta del error.
import { login, logout } from 'qvapay-sdk';
const { accessToken } = await login(userLogin);
const res = await logout(accessToken);🔔 En los ejemplos que siguen, se usa el accessToken que retorna la función login(). Sin embargo, tenga presente que usted puede guardar este token de la forma que prefiera y usarlo posteriormente para realizar operaciones en su aplicación.
La sección User ofrece una variedad de funcionalidades para administrar la información de los usuarios. La función getUser permite obtener información acerca de un usuario específico. La función updateUser permite actualizar la información del usuario. La función deposit permite realizar depósitos en la cuenta del usuario. Por último, la función withdraw permite realizar retiros desde la cuenta del usuario. Estas funcionalidades permiten a los usuarios administrar sus cuentas de forma segura y eficiente. Todas las funciones retornan una promesa con la data o el error de la request.
Este código es una función asíncrona que obtiene un usuario de la API de Qvapay. Esta función toma un token de acceso como parámetro y realiza una solicitud GET a la ruta '/user' con el token de acceso en los encabezados. Si la solicitud se completa con éxito, devuelve los datos del usuario como respuesta. Si hay algún error, devuelve los datos del error como respuesta.
import { login, getUser } from 'qvapay-sdk';
const { accessToken } = await login(userLogin);
const res = await getUser(accessToken);Esta función se utiliza para actualizar un usuario en la API de Qvapay. Toma dos parámetros: un token de acceso y los datos a actualizar. La función intenta realizar la solicitud PUT a la API con los datos proporcionados y el token de acceso. Si la solicitud es exitosa, devuelve los datos recibidos. Si hay algún error, devuelve los datos recibidos en la respuesta del error.
import { login, updateUser } from 'qvapay-sdk';
const { accessToken } = await login(userLogin);
const dataToUpdate = {
name: 'Pedro Perez1',
lastname: 'st',
bio: 'svwb erberberb',
logo: '',
kyc: 1,
username: 'wpiuwe',
email: '[email protected]',
password: 'CffasdKB73iTtzNJN',
};
const res = await updateUser(accessToken, dataToUpdate);Esta función se utiliza para realizar un depósito. La función toma dos parámetros: un token de acceso y un nuevo depósito. Utiliza la API de Qvapay para realizar el depósito. Si hay un error, la función devuelve los datos de la respuesta del servidor. Si no hay errores, devuelve los datos de la transacción.
import { login, deposit } from 'qvapay-sdk';
const { accessToken } = await login(userLogin);
const newDeposit = {
pay_method: 'BTCLN',
amount: 67,
};
const res = await deposit(accessToken, newDeposit);Esta función se utiliza para hacer una extracción de la API Qvapay. Toma dos parámetros: un token de acceso y un objeto Withdraw. Luego, intenta realizar una solicitud POST a la ruta '/withdraw' con los datos del objeto Withdraw y el token de acceso en el encabezado. Si la solicitud es exitosa, devuelve los datos recibidos. Si hay algún error, devuelve los datos recibidos en la respuesta del error.
import { login, withdraw } from 'qvapay-sdk';
const { accessToken } = await login(userLogin);
const newWithdraw = {
pay_method: 'BTCLN',
amount: 4,
details: [
{
Wallet: 'bc1qs67kwcf7znpnc06xjh8cnc0zwsechcfxscghun',
},
],
};
const res = await withdraw(accessToken, newWithdraw);La sección Transactions ofrece una variedad de funciones para administrar las transacciones y retiros realizados por los usuarios. Estas funciones incluyen getOneTransaction, que permite obtener información sobre una transacción específica; getOneWithdraw, que permite obtener información sobre un retiro específico; getTransactionsFromUserAuth, que permite obtener todas las transacciones realizadas por el usuario autenticado; getWithdrawsFromUserAuth, que permite obtener todos los retiros realizados por el usuario autenticado; payPendingTransaction, que permite pagar una transacción pendiente; y transferBetweenUser, que permite transferir fondos entre dos usuarios. Estas funciones permiten a los usuarios administrar sus transacciones y retiros de forma segura y eficiente.
Esta función obtiene transacciones de un usuario autenticado. Toma dos parámetros, un token de acceso y un objeto de propiedades de transacción. Convierte el objeto de propiedades en entradas y parámetros de búsqueda, luego hace una solicitud GET a la API qvapay con los encabezados adecuados. Si la solicitud se realiza con éxito, devuelve los datos recibidos. Si hay un error, devuelve los datos recibidos como respuesta del error.
import {login, getTransactionsFromUserAuth} from 'qvapay-sdk'
const { accessToken } = await login(userLogin);
const props = {
start: date_time
end: date_time
status: [paid, pending, cancelled]
remote_id: string
description: string
}
const res = await getTransactionsFromUserAuth(accessToken, props)Este código es una función asíncrona que se utiliza para obtener una transacción específica a partir de un token de acceso y un ID. Utiliza la API Qvapay para hacer la solicitud, y devuelve los datos de la transacción como respuesta. Si hay algún error, devuelve los datos de la respuesta del error.
import { login, getOneTransaction } from 'qvapay-sdk';
const { accessToken } = await login(userLogin);
const id = '7e48853f-949c-4271-9b4a-1213ee83ac11';
const res = await getOneTransaction(accessToken, id);Esta función se utiliza para obtener los retiros de un usuario autenticado. Utiliza el token de acceso proporcionado como parámetro para realizar una solicitud GET a la API Qvapay. Si la solicitud es exitosa, devuelve los datos recibidos en forma de respuesta con retiro. Si hay algún error, devuelve los datos recibidos en la respuesta del error.
import { login, getWithdrawsFromUserAuth } from 'qvapay-sdk';
const { accessToken } = await login(userLogin);
const res = await getWithdrawsFromUserAuth(accessToken);Esta función recibe dos parámetros: un token de acceso y una identificación. Esta función intenta obtener los datos de un retiro específico a través de la API Qvapay utilizando el token de acceso proporcionado. Si la solicitud se realiza con éxito, devuelve los datos del retiro. Si hay algún error, devuelve los datos del error.
import { login, getOneWithdraw } from 'qvapay-sdk';
const { accessToken } = await login(userLogin);
const id = '10790';
const res = await getOneWithdraw(accessToken, id);Esta función se utiliza para transferir fondos entre usuarios. La función toma dos parámetros: accessToken y transfer. El accessToken se utiliza para autenticar la solicitud de transferencia. El transfer es un objeto que contiene información sobre el monto a transferir, el destinatario, etc. La función realiza una solicitud POST a la API qvapay para realizar la transferencia. Si la solicitud es exitosa, devuelve los datos de la transacción como resultado. En caso de error, devuelve los datos de error.
import { login, transferBetweenUser } from 'qvapay-sdk';
const { accessToken } = await login(userLogin);
const transfer = {
to: '52ff1628-5e91-4083-bc8e-6accce9a7d15',
amount: 10,
description: 'TESTING',
};
const res = await transferBetweenUser(accessToken, transfer);Esta función se encarga de realizar el pago de una transacción pendiente. Toma como parámetros el token de acceso y los detalles de la transacción a pagar. Intenta realizar el pago utilizando la API Qvapay y devuelve una respuesta con los resultados. Si hay un error, devuelve los datos del error. El PIN por defecto es 0000, pero se recomienda configurar un PIN secreto en el panel de usuario para mayor seguridad.
import { login, payPendingTransaction } from 'qvapay-sdk';
const { accessToken } = await login(userLogin);
const pay = {
uuid: '710296b7-0d5d-4e86-ab1b-9d79080dd042',
pin: '0000',
};
const res = await payPendingTransaction(accessToken, pay);La sección Merchants le permite a los usuarios realizar operaciones financieras como consultar el saldo de una aplicación, obtener información sobre una aplicación, crear facturas, obtener una transacción de una aplicación y obtener transacciones de una aplicación. Estas funcionalidades le permiten al usuario administrar sus finanzas con facilidad y seguridad.
Esta función se utiliza para obtener información sobre una aplicación. La función toma un objeto "AppAuth" como parámetro y devuelve un objeto "AppInfo" como promesa. La función intenta realizar una solicitud POST a la API qvapay para obtener la información de la aplicación. Si la solicitud es exitosa, devuelve los datos recibidos en el objeto "data". Si hay algún error, devuelve los datos recibidos en el objeto "response".
import { appInfo } from 'qvapay-sdk';
const res = await appInfo(appAuth);Esta función se utiliza para obtener el saldo de una aplicación. Utiliza la API de Qvapay para enviar una solicitud POST con los datos de autenticación de la aplicación. Si la solicitud se procesa correctamente, devuelve los datos del saldo. Si hay un error, devuelve los datos del error.
import { appBalance } from 'qvapay-sdk';
const res = await appBalance(appAuth);Esta función permite crear una factura mediante la API de Qvapay. La función toma un objeto "invoice" como parámetro y devuelve una promesa con el objeto de respuesta "InvoiceResponse". El código intenta realizar una solicitud POST a la API de Qvapay para crear la factura. Si hay algún error, el código captura el error y devuelve los datos de la respuesta.
import { createInvoice } from 'qvapay-sdk';
const invoice = {
...appAuth,
amount: 99.99,
description: 'Enanitos verdes',
remote_id: 'MY_OWN_CUSTOM_ID',
signed: 1,
};
const res = await createInvoice(invoice);Esta función toma un parámetro auth de tipo AppAuth. Esta función hace una solicitud POST a la API qvapay para obtener datos de transacciones. Si la solicitud se realiza con éxito, devuelve los datos recuperados en formato de promesa. Si hay algún error, devuelve los datos recuperados en el objeto de respuesta AxiosError.
import { getTransactionsFromApp } from 'qvapay-sdk';
const res = await getTransactionsFromApp(appAuth);Esta función se utiliza para obtener una transacción específica de una aplicación. Toma dos parámetros: auth (una autenticación de la aplicación) y id (el identificador de la transacción). La función envía una solicitud POST al servidor para recuperar los datos de la transacción especificada. Si la solicitud tiene éxito, devuelve los datos recuperados. En caso contrario, devuelve los datos del error.
import { getOneTransactionFromApp } from 'qvapay-sdk';
const id = '54079648-39bc-49ef-bd3e-b89032a7ac05';
const res = await getOneTransactionFromApp(appAuth, id);La sección Payment Links le permite a los usuarios crear enlaces de pago personalizados para recibir pagos de sus clientes. Estos enlaces pueden ser compartidos a través de correo electrónico, redes sociales o cualquier otra plataforma para que los clientes realicen el pago directamente desde su dispositivo. Además, la sección Payment Links también le permite al usuario ver todos los enlaces de pago creados y consultar el estado de cada uno.
Esta función se utiliza para obtener todos los enlaces de pago. Utiliza la API QVAPay para realizar una solicitud GET a la ruta '/payment_links' con el token de acceso proporcionado como encabezado. Si la solicitud se realiza correctamente, devuelve los datos recibidos en la respuesta. En caso de error, devuelve los datos recibidos en la respuesta del error.
import { login, getAllPaymentLinks } from 'qvapay-sdk';
const { accessToken } = await login(userLogin);
const res = await getAllPaymentLinks(accessToken);Esta función crea un enlace de pago usando la API de Qvapay. Toma un token de acceso y un objeto con información sobre el pago como parámetros, realiza una solicitud POST a la API y devuelve los datos de respuesta. Si hay algún error, captura la excepción y devuelve los datos de respuesta.
import { login, createPaymentLink } from 'qvapay-sdk';
const { accessToken } = await login(userLogin);
const info = {
name: 'Pulover de guinga azul',
product_id: 'PVG-AZUL',
amount: 10.32,
};
const res = await createPaymentLink(accessToken, info);Nuestra sección de servicios cuenta con dos funcionalidades principales: getAllServices y getOneService, que te permiten obtener información detallada sobre cada uno de nuestros servicios.
Esta función se encarga de obtener todos los servicios disponibles. Esta función toma un token de acceso como parámetro y realiza una solicitud GET a la API qvapay para obtener los datos de los servicios. Si la solicitud es exitosa, devuelve los datos como respuesta. En caso contrario, devuelve los datos de la respuesta del error.
import { login, getAllServices } from 'qvapay-sdk';
const { accessToken } = await login(userLogin);
const res = await getAllServices(accessToken);Esta función se utiliza para obtener un servicio específico utilizando un token de acceso y un ID. Utiliza la API Qvapay para realizar la solicitud y devolver los datos del servicio solicitado. Si hay un error, maneja el error y devuelve los datos de la respuesta.
import { login, getOneService } from 'qvapay-sdk';
const { accessToken } = await login(userLogin);
const id = 'e286449c-5bf4-4fbc-9a85-95bb5b54c73e';
const res = await getOneService(accessToken, id);La sección P2P ofrece una variedad de funciones para facilitar el intercambio de monedas digitales entre usuarios. Estas funciones incluyen getEnabledCurrencies, que permite a los usuarios ver qué monedas están habilitadas para el intercambio; getOffers, que permite a los usuarios ver todas las ofertas disponibles; getOneOffer, que permite a los usuarios ver una oferta específica; y getPairsAverage, que calcula el promedio de precios para un par de monedas específico. Estas herramientas permiten a los usuarios realizar transacciones rápidas y seguras con otros usuarios en la plataforma.
Esta función se utiliza para obtener una lista de monedas habilitadas. Utiliza la API de Qvapay para realizar una solicitud GET a la ruta '/p2p/get_coins_list'. Si la solicitud se completa con éxito, devuelve los datos recibidos. Si hay algún error, devuelve los datos de la respuesta del error.
import { getEnabledCurrencies } from 'qvapay-sdk';
const res = await getEnabledCurrencies();Esta función se utiliza para obtener el promedio de pares completados para una moneda específica. Utiliza la API de Qvapay para realizar la solicitud y devuelve los datos como una respuesta de promesa. En caso de que ocurra un error, maneja la excepción y devuelve los datos del error como respuesta.
import { getPairsAverage } from 'qvapay-sdk';
const coin = 'TRX';
const res = await getPairsAverage(coin);Esta función toma dos parámetros: accessToken y props. Primero, convierte los parámetros en un objeto URLSearchParams y luego realiza una solicitud GET a la API con el token de acceso proporcionado como encabezado de autorización. Si la solicitud se completa correctamente, devuelve los datos recibidos. Si hay algún error, devuelve los datos del error recibido en la respuesta.
import { login, getOffers } from 'qvapay-sdk';
const { accessToken } = await login(userLogin);
const props = {
type: 'buy',
coin: 'ETECSA',
min: 1,
max: 50,
};
const res = await getOffers(accessToken, props);Esta función se utiliza para obtener una oferta específica a través de la API QVapay. La función toma dos parámetros: accessToken y id. Utiliza el token de acceso para autenticar la solicitud y el id para identificar la oferta específica. Luego, realiza una solicitud GET a la API QVapay para recuperar los datos de la oferta. Si hay algún error, manejará la respuesta del servidor y devolverá los datos. Finalmente, devuelve los datos de la oferta como un objeto Promise.
import { login, getOneOffer } from 'qvapay-sdk';
const { accessToken } = await login(userLogin);
const id = '949780ed-7303-4a34-b8c3-2d55d802c75d';
const res = await getOneOffer(accessToken, id);La sección reates cuenta con las funciones currentCoins, currentRates. Haciendo uso de estas puede mantener a sus usuarios al tanto de las tarifas actualizadas.
Esta función devuelve una promesa de una matriz de tasas actuales. Obtiene los datos desde la API de qvapayAPI. Si la solicitud se realiza correctamente, devolverá los datos recibidos. Si hay algún error en la solicitud, devolverá los datos recibidos en la respuesta del error.
import { currentRates } from 'qvapay-sdk';
const res = await currentRates();Esta función devuelve una promesa con una matriz de tasas actuales. Esta función obtiene los datos de la API qvapay. Si la solicitud es exitosa, los datos se devuelven como parte de la respuesta. Si hay un error, los datos se devuelven como parte de la respuesta del error. Esta función es útil para obtener información sobre las monedas actuales y sus tasas de cambio.
import { currentCoins } from 'qvapay-sdk';
const res = await currentCoins();💡 Este proyecto está en desarrollo y busca ofrecer una solución de código abierto para interactuar con la API de QvaPay. Estamos abiertos a cualquier sugerencia o feedback que nos ayude a mejorar el proyecto. Estamos comprometidos con la satisfacción de nuestros usuarios, por lo que cualquier contribución es bienvenida. Si tienes alguna idea para mejorar el proyecto, no dudes en compartirla con nosotros. ¡Estamos ansiosos por escuchar tus ideas!