Ir al contenido

Integraciones y API

Arquitectura de Integración

Socios e integraciones

El permiso hola-doc.integrations permite administrar:

  • API keys de integración.
  • Socio comercial asignado a cada key.
  • Porcentaje o reglas de comisión.
  • Mapeos de SKU a plan.
  • Tiendas asociadas al partner.
  • SKUs de acceso a cabina.
  • Proveedores de exportación y costos por plan.

Las integraciones externas usan el header:

X-Api-Key: {api-key}

Una key inválida o inactiva responde 401 Unauthorized.

Endpoint externo:

POST /api/hola-doc/transactions/ingest

Uso principal: recibir ventas y devoluciones desde POS.

Campos clave de transacción:

CampoUso
retailStoreIdTienda o punto de venta.
businessDayDateFecha de negocio.
workstationIdCaja o estación.
transNumberNúmero único de factura.
operatorIdOperador o cajero.
customerIdCédula o documento del cliente.
customerDateOfBirthFecha de nacimiento.
items[].itemIdSKU que debe estar mapeado.

El endpoint puede responder 200 aunque existan transacciones rechazadas. Siempre revise created, duplicates, errors, rejected y processingErrors.

Endpoint externo:

POST /api/hola-doc/registry/lookup

Permite consultar el estado de una persona por cédula sin modificar datos.

Rechazos por reglas de negocio se guardan para consulta operativa. Ejemplos:

  • Menor de edad.
  • Edad sobre el límite de inscripción.
  • Conflicto de correo.
  • Suscripción suspendida.
  • Mezcla de productos de cabina y suscripción.
  • Nota de crédito sin suscripción activa (ver Notas de crédito).
  • Acceso de cabina ya consumido.

Los rechazos de formato no necesariamente se persisten.

  • Batch máximo de ingesta: 10,000 transacciones.
  • Transacciones duplicadas por transNumber se reportan como duplicadas y no se procesan de nuevo.