API de Catálogo

Documentación para integraciones externas (ej. CanchApp)

Endpoint de consulta

GET

https://<endpoint-url>

Encuentra la URL exacta en: Dashboard → Code → Functions → catalogApi

Devuelve la lista de productos del catálogo global (1 productos actualmente).

Autenticación

Envía la API Key en cada petición usando cualquiera de estos headers:

Authorization: Bearer <FLAZH_API_KEY>

— o —

X-API-Key: <FLAZH_API_KEY>

La API Key se gestiona desde: Dashboard → Settings → Environment Variables → FLAZH_API_KEY

Parámetros de consulta

Parámetro	Default	Descripción
page	1	Número de página
limit	100	Items por página (máx 500)
status	active	`active`, `inactive` o `all`
category	—	Filtra por categoría exacta
search	—	Busca en nombre y palabras clave

GET https://<endpoint-url>?page=1&limit=100&status=active

Formato de respuesta

{
  "page": 1,
  "limit": 100,
  "total": 150,
  "total_pages": 2,
  "has_more": true,
  "products": [
    {
      "id": "...",
      "name": "Arroz",
      "category": "Granos",
      "unit": "kg",
      "item_nature": "both",
      "barcode": "",
      "image_url": "https://...",
      "price": null,
      "status": "active",
      "dish_modules": ["arroz"],
      "keywords": ["arroz blanco"],
      "times_adopted": 3,
      "created_date": "...",
      "updated_date": "..."
    }
  ]
}

Nota sobre price: El catálogo global no maneja precios — los precios se configuran por tienda. El campo viene como null.

Webhook de actualización

Cuando un producto del catálogo se crea, actualiza o elimina, Flazh envía un POST a la URL configurada de CanchApp:

POST https://<canchapp-webhook-url>
Content-Type: application/json

{
  "event": "create" | "update" | "delete",
  "product": {
    "id": "...",
    "name": "...",
    "category": "...",
    "unit": "...",
    "status": "active" | "inactive",
    ...
  },
  "timestamp": "2026-08-07T19:40:00Z"
}

URL destino: Se configura en Environment Variables como CANCHAPP_WEBHOOK_URL

Una vez que CanchApp proporcione su URL de webhook, configúrala en el dashboard para activar la sincronización en tiempo real.

Límites de uso

Máximo 500 items por página
El catálogo se carga en una sola consulta (apropiado para hasta ~2000 productos)
El webhook dispara en tiempo real ante cualquier cambio del catálogo