Casos de uso
A continuación se presentan escenarios prácticos de integración con la API de Quickex.
Para nuevas integraciones se recomienda API v2 (firma de solicitudes, lista blanca de IP).
Para datos públicos de vitrina y seguimiento de órdenes, están disponibles métodos convenientes de API v1.
No mezcles tasas obtenidas de una versión de la API al crear transacciones en otra.
1) Integrar un exchange en el sitio web
Objetivo
añadir al sitio un formulario de intercambio con selección de moneda/red, validación de dirección y creación de orden.
Endpoints
- v2:
POST /api/v2/instruments/public/validate-address,POST /api/v2/instruments/public/one,GET /api/v2/instruments/public,POST /api/v2/orders/public/create,POST /api/v2/orders/public/set-email - v1 (adicionalmente si se necesitan estados/vitrina):
GET /api/v1/instruments/public,GET /api/v1/instruments/public/one,POST /api/v1/instruments/public/validate-address
Flujo
- Cargar el catálogo de instrumentos activos (moneda + red) para construir las listas “Entrego/Recibo”.
- Tras la selección del usuario, solicitar los detalles del instrumento “recibo” (precisión, memo/tag, límites).
- Validar la dirección de destino mediante
validate-address. - Crear la orden:
POST /api/v2/orders/public/create(se recomienda v2). Guardar elorderIdy mostrar al usuario eldepositAddress. - (Opcional) añadir un email a la orden:
POST /api/v2/orders/public/set-email— para notificaciones al usuario. - Mostrar una pantalla con instrucciones de pago al
depositAddressy un temporizador.
Errores y seguridad
- Bloquea el envío del formulario hasta que la dirección se haya validado correctamente.
- Respeta
requiresMemo/tag— solicita al usuario introducir un memo/tag si es obligatorio. - En v2 — firma cada solicitud y restringe IPs mediante una lista blanca.
2) Obtención y visualización de tipos de cambio
Objetivo
mostrar al usuario tipos de cambio actualizados para el par seleccionado.
Endpoints
- v1:
GET /api/v1/rates/public/one— tipo de cambio público en JSON.
Flujo
- Cuando el usuario elija un par, solicita el tipo de cambio público mediante
rates/public/one. - Muestra el tipo de cambio, los importes mínimo/máximo (si se devuelven) y la marca temporal de vigencia.
- (Opcional) aplica un “markup” visual al tipo de cambio mostrado en la vitrina (ver Escenario 4), pero no uses la tasa ajustada para crear realmente una orden en otra versión de la API.
Recomendaciones
- Almacena en caché las respuestas durante 10–30 segundos para reducir la carga.
- Muestra la hora de actualización y un botón “Actualizar tasa”.
3) Creación y seguimiento de órdenes
Objetivo
crear una orden y proporcionar al usuario un estado de ejecución claro.
Endpoints
- v2:
POST /api/v2/orders/public/create,POST /api/v2/orders/public/set-email - v1:
POST /api/v1/orders/public/create,GET /api/v1/orders/public-info,GET /api/v1/orders/public/latest,POST /api/v1/orders/public/accept-rate-mode-change,POST /api/v1/orders/public/request-refund,GET /api/v1/orders/order-refund-info
Flujo (v2 — recomendado para la creación)
- Validar los datos de entrada y la dirección de destino.
- Crear la orden:
v2/orders/public/create→ obtenerorderId,depositAddress. - Ofrecer “Añadir email”:
v2/orders/public/set-email. - Mostrar al usuario las instrucciones para realizar el depósito.
Seguimiento del estado (vitrina y cuenta del usuario)
- Vitrina “últimos intercambios”:
GET /api/v1/orders/public/latest. - Detalles de una orden específica:
GET /api/v1/orders/public-info?orderId=...&destinationAddress=...— arreglosdeposits/withdrawals,confirmations,txId,networkFee. - Cambio del modo de tasa a petición:
POST /api/v1/orders/public/accept-rate-mode-change. - Reembolsos:
POST /api/v1/orders/public/request-refund→ detalles medianteGET /api/v1/orders/order-refund-info.
Notas
- Almacena el
orderIden tu backend y vincúlalo a la sesión del usuario. - Para usuarios autenticados, utiliza
GET /api/v1/orders/public/list(etiqueta auth) como panel personal de órdenes.
4) Comprobación del estado de las transacciones
Objetivo
dar al usuario transparencia sobre el progreso de los depósitos y retiros.
Endpoints
- v1:
GET /api/v1/orders/public-info,GET /api/v1/orders/order-refund-info
Flujo
- Sondea periódicamente
public-infopororderIdydestinationAddress. - En el bloque
deposits[0], analizaisPending,confirmations,txId,depositAddress. - Cuando el depósito esté confirmado — muestra la información del retiro desde el arreglo
withdrawals(monto,networkFee,txId). - En caso de reembolso — obtén los detalles mediante
order-refund-infoy muestra el estado “Reembolso en progreso/completado”.
Recomendaciones
- Intervalo de sondeo de 5–15 segundos, con backoff en 429/5xx.
- Muestra un enlace a un explorador de blockchain por
txId, si está disponible. - Añade advertencias visuales para direcciones que requieran memo/tag.