Casos de uso

Author profile photo
Equipo Quickex
31 de agosto de 2025
~3 lectura mínima

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

  1. Cargar el catálogo de instrumentos activos (moneda + red) para construir las listas “Entrego/Recibo”.
  2. Tras la selección del usuario, solicitar los detalles del instrumento “recibo” (precisión, memo/tag, límites).
  3. Validar la dirección de destino mediante validate-address.
  4. Crear la orden: POST /api/v2/orders/public/create (se recomienda v2). Guardar el orderId y mostrar al usuario el depositAddress.
  5. (Opcional) añadir un email a la orden: POST /api/v2/orders/public/set-email — para notificaciones al usuario.
  6. Mostrar una pantalla con instrucciones de pago al depositAddress y 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

  1. Cuando el usuario elija un par, solicita el tipo de cambio público mediante rates/public/one.
  2. Muestra el tipo de cambio, los importes mínimo/máximo (si se devuelven) y la marca temporal de vigencia.
  3. (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)

  1. Validar los datos de entrada y la dirección de destino.
  2. Crear la orden: v2/orders/public/create → obtener orderId, depositAddress.
  3. Ofrecer “Añadir email”: v2/orders/public/set-email.
  4. 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=... — arreglos deposits/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 mediante GET /api/v1/orders/order-refund-info.

Notas

  • Almacena el orderId en 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

  1. Sondea periódicamente public-info por orderId y destinationAddress.
  2. En el bloque deposits[0], analiza isPending, confirmations, txId, depositAddress.
  3. Cuando el depósito esté confirmado — muestra la información del retiro desde el arreglo withdrawals (monto, networkFee, txId).
  4. En caso de reembolso — obtén los detalles mediante order-refund-info y 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.
Comparte este artículo: