Tema
🚧Contrato en borrador. Estos pasos describen la integración prevista; los endpoints aún no están disponibles.
1. Prepara tu comercio en COME
En el portal de comercios (COME Comercios):
- Revisa que tus descuentos estén vigentes y con el estado correcto.
- Si tienes descuentos por categoría o artículo, registra tus artículos con el mismo SKU que usa tu sistema de facturación: la API calcula el descuento comparando esos SKU.
- En Empresas afiliadas confirma qué empresas otorgan tus descuentos a sus colaboradores.
2. Crea tu credencial
Entra a tu oficina virtual de COME con un usuario que tenga el permiso Manage API keys and OAuth clients (merchant.integrations.manage) y abre Integrations. Allí eliges el tipo de credencial:
| Cliente OAuth 2.0 | API key | |
|---|---|---|
| Recomendado para | Sistemas que ya manejan OAuth (ERP, e-commerce) | Integraciones sencillas (un POS, un script) |
| Qué recibes | client_id + client_secret | Llave ck_{prefijo}.{secreto} |
| Cómo se usa | Pides un token y envías Authorization: Bearer … | Envías X-Api-Key: ck_… en cada llamada |
| Vigencia | Token de 15 minutos; el secret dura hasta que lo rotes | 30, 90, 180 o 365 días |
El secreto se muestra una sola vez
Cópialo en ese momento a un gestor de secretos o variable de entorno del servidor. Si lo pierdes, rota el secret (cliente OAuth) o crea una nueva API key.
El detalle de cada tipo está en Autenticación.
3. Consulta los tipos de identificación
bash
curl -s "$COME_BASE_URL/api/v1/integrations/identification-types" \
-H "Authorization: Bearer $COME_TOKEN"Guarda el id de cada tipo (por ejemplo, Cédula): lo usarás como identificationTypeId.
4. Valida a un colaborador
bash
curl -s -X POST "$COME_BASE_URL/api/v1/integrations/eligibility" \
-H "Authorization: Bearer $COME_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "identificationTypeId": 1, "identification": "00000000000", "purchaseAmount": 1500.00 }'Si value.eligible es true, value.discounts trae los beneficios que puedes aplicar. Continúa con el flujo de canje para aplicarlo y notificar el consumo.
Datos de prueba
En el ambiente de pruebas usa solo identificaciones y datos ficticios que COME te asigne. Nunca pruebes con datos reales de clientes o colaboradores.

