Conceptos clave
Antes de empezar, familiarízate con estos términos. Los vas a ver en toda la documentación.
Grupo
Un grupo agrupa una o más unidades de cobro bajo una misma cuenta bancaria y configuración. Pensalo como una sucursal: si tienes 3 sucursales, tendrás 3 grupos. Cada grupo tiene su propio juego de credenciales (API Key + Clave Secreta).
Unidad de Cobro
Una unidad de cobro es una caja registradora individual dentro de un grupo. Si tu sucursal tiene 4 cajas, tendrás 4 unidades de cobro en ese grupo. Cada unidad de cobro tiene un identificador único que se usa al abrir sesión.
Sesión
Una sesión representa el período en que una caja está abierta y puede generar cobros.
Empieza con POST /session/device (apertura de caja) y termina con
DELETE /session/device (cierre de caja). El token retornado en la apertura
se usa como authorization en todas las llamadas subsiguientes.
QR Dinámico vs Estático
QR Dinámico (DYN): generado por la API en el momento del cobro, se muestra en la pantalla de la caja. Único por transacción.
QR Estático (HYB): imagen descargada previamente desde Yappy Comercial, impresa y colocada físicamente. Solo funciona cuando existe una orden pendiente por pagar.
| Característica | QR Dinámico (DYN) | QR Estático (HYB) |
|---|---|---|
| Generación | En tiempo real vía API | Descargado desde Yappy Comercial |
| Unicidad | Único por transacción | Reutilizable con nueva orden |
| Uso típico | Pantalla de caja / POS | Impreso en mostrador / factura |
| Requiere pantalla | Sí | No |