Glosario

Integración

Término	Definición
Webhook	Petición POST con JSON que IDPOS envía a su URL cuando ocurre un evento.
Evento	Hecho de negocio que dispara un envío, como Orden aceptada. Tiene un nombre de negocio y un identificador técnico, como order.accepted, que llega en event_type.
Suscripción	Registro, hecho por IDBI, que asocia una tienda, una URL, los eventos que recibe y un secreto propio. Cada suscripción pertenece a una sola tienda.
Endpoint	URL pública con HTTPS de su sistema que recibe los envíos.
Payload	Contenido del envío: el cuerpo JSON de la petición, con el sobre y el objeto data.
Secreto	Cadena que IDPOS genera al registrar cada suscripción y que se usa para calcular la firma. Solo puede consultarse en ese momento.
Firma	Valor de X-Webhook-Signature: HMAC-SHA256 en hexadecimal de {X-Webhook-Timestamp}.{cuerpo}.
HMAC	Código de autenticación de mensaje basado en una función hash y un secreto compartido.
Cuerpo crudo	Bytes exactos de la petición, tal como llegaron, sin interpretar ni reserializar.
Tolerancia	Diferencia máxima, 300 segundos, entre X-Webhook-Timestamp y la hora de su servidor.
api_version	Versión del formato de los eventos. La versión vigente es v1.
Sobre	Estructura común de los eventos en la configuración estándar: event_id, event_type, timestamp, api_version y data.

Entrega

Término	Definición
Entrega al menos una vez	Garantía de que cada evento llega una o más veces. Puede haber duplicados.
Idempotencia	Propiedad de un procesamiento que, ejecutado varias veces con el mismo evento, produce el mismo resultado.
Deduplicación	Descarte de los eventos que ya se procesaron, usando el event_id del cuerpo ya verificado.
Reintento	Nuevo envío de un evento cuyo envío anterior falló.
Intento	Cada petición HTTP de entrega de un evento. Por defecto hay hasta 5 por evento.
Tiempo de espera	Tiempo máximo que IDPOS espera su respuesta. Por defecto, 30 segundos.

Negocio

Término	Definición
Orden	Venta registrada en IDPOS, con sus líneas, pagos y cliente.
Línea	Producto de una orden. Puede tener modificadores y, si es un combo, componentes.
Modificador (topping)	Agregado a un producto, como «queso extra». Se envía en toppings[].
Combo	Producto compuesto por varios componentes, enviados en combo_products[].
SKU	Código del ítem.
Código externo (external_id)	Identificador del registro en un sistema externo.
Punto de atención (spot)	Mesa o lugar donde se atiende la orden.
Tienda (store)	Establecimiento de IDPOS al que pertenece el evento.
Medio de pago	Forma en que se paga, con un nombre (method_name) y un tipo (method_type).
Comprobante	Boleta (RECEIPT), factura (INVOICE) o nota de crédito (CREDIT_NOTE).
IGV	Impuesto General a las Ventas.
ISC	Impuesto Selectivo al Consumo.
Anticipo	Cobro registrado antes de la venta, que luego puede consumirse como medio de pago.
Correlativo	Número secuencial de un documento.