API Technical Docs

Mantente al día con las innovaciones tecnológicas que están transformando el mercado.

Usuarios, dispositivos y turnos

Estado documental: Propuesto. Este documento define el registro de usuarios, la identificación obligatoria y el ciclo de vida de un turno asociado con una sola persona y un dispositivo.

Usuarios registrados

La empresa registra previamente a los vendedores u operadores autorizados en YUPY.

Cada usuario debe disponer de un mecanismo de identificación, por ejemplo:

  • usuario y contraseña;
  • código personal;
  • PIN;
  • enlace autenticado;
  • otro método aprobado.

El mecanismo definitivo depende del canal y de la implementación de seguridad.

Identificación obligatoria al abrir turno

Un usuario no puede iniciar operaciones del turno sin identificarse.

Usuario abre el chat
        ↓
Solicita iniciar turno
        ↓
YUPY pide identificación
        ↓
Usuario ingresa sus credenciales
        ↓
YUPY valida
        ↓
Crea el turno
        ↓
Asocia persona + dispositivo + canal

Qué representa el turno

El turno representa:

una persona identificada
+ un dispositivo determinado
+ un canal autorizado
+ una ventana operativa

Todas las transacciones originadas durante el turno pertenecen a la persona que lo abrió.

Regla: un turno pertenece a una sola persona. Para operar con otra persona, se cierra el turno actual y se abre uno nuevo después de identificar al siguiente usuario.

Datos del turno

El turno puede registrar:

  • shift_id;
  • user_id o seller_id;
  • device_id o terminal_id;
  • canal;
  • identidad del canal protegida;
  • hora de apertura;
  • duración máxima;
  • hora de cierre;
  • estado;
  • empresa;
  • perfil principal de cobro.

Operaciones creadas manualmente

El turno activo permite al vendedor crear cobros desde el chat.

YUPY añade automáticamente a la operación:

  • usuario;
  • turno;
  • dispositivo;
  • canal;
  • fecha y hora.

Operaciones recibidas por API

Cuando un sistema de ventas crea una transacción, debe indicar el turno y el dispositivo de destino.

Sistema de ventas
    → external_transaction_id
    → amount
    → currency
    → shift_id
    → device_id o terminal_id

YUPY
    → valida que el turno esté activo
    → identifica a la persona
    → entrega QR e instrucciones al chat correcto

Si el turno no existe, está cerrado o no corresponde al dispositivo, YUPY debe rechazar o dejar pendiente la entrega según el contrato acordado.

Duración máxima

La empresa configura la duración máxima del turno.

Puede elegir una de dos modalidades.

Modalidad A: cierre automático

Al alcanzar el límite, YUPY cierra el turno automáticamente para nuevas operaciones.

Una transacción ya iniciada conserva su seguimiento y conciliación.

Modalidad B: aviso y renovación

Cuando se supera el límite, YUPY permite terminar la atención actual y, después de cada transacción, recuerda al usuario que debe cerrar y abrir un nuevo turno.

Tu turno superó la duración configurada.
Finaliza esta operación.
Luego sal e identifícate nuevamente
para iniciar un nuevo turno.

La empresa elige la modalidad durante la configuración.

Cierre manual

El usuario puede cerrar su turno desde el chat.

El cierre:

  • impide crear nuevas operaciones dentro de ese turno;
  • conserva todas las transacciones;
  • no detiene conciliaciones en curso;
  • no elimina pendientes;
  • no cambia la persona asociada.

Nuevo usuario

Cuando otra persona utilizará el mismo dispositivo:

1. Se cierra el turno actual.
2. El nuevo usuario solicita iniciar turno.
3. YUPY solicita identificación.
4. Se crea un nuevo shift_id.
5. Las operaciones nuevas pertenecen al nuevo turno.

Operación del vendedor

Según permisos, el vendedor puede:

  • crear cobros;
  • recibir cobros originados por API;
  • consultar el estado de sus transacciones;
  • marcar “Ya pagó”;
  • enviar capturas o fotografías;
  • ver diferencias y pendientes relacionados con su turno;
  • cancelar transacciones cuando esté autorizado;
  • cerrar el turno.

El acceso a reportes generales o administración corresponde a perfiles separados.

Cierre y resultados posteriores

Un turno puede cerrarse con operaciones todavía en proceso.

Los pagos tardíos, diferencias, constancias o devoluciones posteriores siguen vinculados con el turno y usuario originales.

Resumen de cierre

YUPY puede entregar al usuario un resumen operativo con:

  • operaciones creadas;
  • pagos confirmados;
  • operaciones pendientes;
  • diferencias;
  • casos que requieren seguimiento.

Este resumen no concede acceso a la consola administrativa completa.

Criterios de aceptación

  1. Los usuarios se registran previamente.
  2. La identificación es obligatoria al abrir turno.
  3. El turno vincula persona, dispositivo y canal.
  4. Cada turno pertenece a una sola persona.
  5. El cobro manual utiliza el turno activo.
  6. El cobro por API indica turno y dispositivo.
  7. La empresa configura una duración máxima.
  8. Puede elegir cierre automático o aviso para renovación.
  9. El nuevo usuario debe abrir un turno nuevo.
  10. El cierre no detiene conciliaciones ni elimina pendientes.