Skip to content

Introducción

🚧Contrato en borrador (v0.1.0). Los endpoints de integración están en diseño y aún no están disponibles en COME.CORE. Úsalo para planificar tu integración; puede cambiar antes de su publicación.

COME es la red de beneficios que conecta empresas, sus colaboradores y los comercios. Las empresas afiliadas eligen qué descuentos de tu comercio otorgan a su equipo; la API de integración le permite a tu punto de venta reconocer a esos colaboradores y aplicarles el beneficio en el momento de la compra.

Qué puedes hacer ​

  1. 1ValidarEl cliente se identifica. Consultas si tiene beneficios en tu comercio.POST /integrations/eligibility
  2. 2AplicarEliges el descuento, COME lo calcula y lo reserva con un código de autorización.POST /integrations/discounts/apply
  3. 3NotificarCobras la compra y confirmas el consumo para que quede registrado.POST /integrations/consumptions
PasoEndpointResultado
1. ValidarPOST /integrations/eligibilitySi el colaborador tiene beneficios hoy en tu comercio, y cuáles.
2. AplicarPOST /integrations/discounts/applyEl descuento calculado y un código de autorización.
3. NotificarPOST /integrations/consumptionsEl consumo registrado en COME, visible para la empresa y el colaborador.

Además, GET /integrations/identification-types devuelve los tipos de identificación aceptados.

Qué necesitas ​

  1. Tu comercio afiliado a COME y al menos una empresa afiliada a tu comercio.
  2. Descuentos publicados desde el portal de comercios (COME Comercios). Si aplican a categorías o artículos, registra también tus artículos con su SKU.
  3. Una credencial de integración (cliente OAuth o API key) creada en tu oficina virtual. Ver Autenticación.
  4. Un sistema servidor (backend de tu POS o e-commerce) que haga las llamadas. Nunca llames a la API desde un navegador o una app móvil con tus credenciales.

Convenciones ​

  • Base URL: {baseUrl}/api/v1. COME te entrega la URL de cada ambiente (pruebas y producción).
  • Formato: JSON en UTF-8, fechas en ISO 8601 con zona horaria y montos en pesos dominicanos (DOP) con dos decimales.
  • Respuestas: mismo sobre que el resto de COME: { title, messages, value, meta }. Los datos están en value.
  • Errores: { code, title, messages }. Ver Errores.
  • Tu comercio sale de la credencial: nunca envías el id del comercio; COME lo toma de la credencial con la que te autenticas.

Siguiente paso ​

Sigue Primeros pasos para tener tu primera llamada funcionando.

COME · Beneficios que te conectan