Esta documentación técnica tiene como objetivo explicar en detalle la integración entre Pedix y otro sistema de gestión, en adelante “el sistema”. La integración permitirá que los pedidos que ingresen a través de Pedix se impacten directamente en el sistema. Para ello, Pedix proporcionará una API para que el sistema pueda acceder al catálogo de productos del cliente, y el sistema deberá desarrollar un endpoint para recibir las notificaciones de nuevos pedidos.
La integración entre Pedix y el sistema se basa en la comunicación entre los dos sistemas a través de dos interfaces principales: la API de Catálogo de Pedix y el webhook para recibir notificaciones de nuevos pedidos. Cuando un cliente realiza un pedido a través de Pedix, el pedido se procesa en tiempo real y se envía una notificación a el sistema a través del webhook. El sistema recibirá la notificación, procesará el pedido y actualizará su sistema con los detalles del pedido.
Pedix proporcionará una API de Catálogo que permitirá a el sistema acceder al catálogo de productos del cliente. La API será pública y no requerirá autenticación para su uso.
Endpoint
https://southamerica-east1-comprarporwhatsapp-develop.cloudfunctions.net/pedixappApi-v1/establishments/ITGx6prFC5a3AZ6fiFjR/catalog
<aside> 💡 Esta URL es exclusivamente para la API de desarrollo. Todavía no tenemos publica la URL de producción.
</aside>
El código ITGx6prFC5a3AZ6fiFjR es el identificador de la tienda prueba en el ambiente de desarrollo. El mismo cambiará para producción, al igual que la url de la API.
El método HTTP que se debe utilizar es GET, ya que se está solicitando información del catálogo.
La respuesta que se recibirá será un objeto JSON que contiene información sobre los productos disponibles en el catálogo del establecimiento.
{
"data": {
"establishmentId": "ITGx6prFC5a3AZ6fiFjR",
"categories": [{
"id": "4eGfKX6XdPnUaQdaFcuS",
"name": "HELADOS",
"image": "<https://cdn.pedix.app/ITGx6prFC5a3AZ6fiFjR/categories/1678472592214.png?size=250&quality=80&env=development>",
"active": true,
"products": [{
"id": "Z6w34Ntc42bQDiuesyU2",
"categoryId": "4eGfKX6XdPnUaQdaFcuS",
"name": "1 KILO",
"price": 3000,
"active": true,
"linkedOptionIds": ["ctMMewVdqvULpXQj0a6U"],
"options": [{
"id": "ctMMewVdqvULpXQj0a6U",
"name": "Sabores 1 KG",
"rangeType": "range",
"min": 1,
"max": 4,
"displayItemQuantities": false,
"linkedItemIds": ["uUqAXAkllUerQIoMwtCO", "A77fJMUVdP1rIRIYVT4L", "LkLwLfMJSeRUjlPsdjuU", "f3OV7BBi6R7MfmFaiS8Y", "GQm8WQWgkQ1SCI8ufTKk", "WwF9ImDsleAfGfItXTX5", "fJOL9dF9YVWNdOeIiuhl", "WiDBnYz6hNHHMssPtEtp", "TwNYSMBLifcDSKpS4kgO", "31SfFyZVydH6uNQ1LIRG", "5PIaMg7cAjvciHIktWD8", "jWNlz28hBjV3kdkz2C9m", "Fr3beUFh0T6Bqwm3lVHT", "biPRCHvS0br2AW0TO7J7", "8YrhDMhQFHVOwli3dAsH", "u40LlQow4q3XzyHiL5uX"],
"items": [{
"id": "uUqAXAkllUerQIoMwtCO",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "COCO CON DULCE DE LECHE",
"description": "Crema infusionada de coco rallado veteado con dulce de leche artesanal.",
"active": true
}, {
"id": "A77fJMUVdP1rIRIYVT4L",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "CREMA CHANTILLY",
"description": "La tradicional crema chantilly hecha helado.",
"active": true
}, {
"id": "LkLwLfMJSeRUjlPsdjuU",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "CREMA DE ALMENDRAS",
"description": "Crema con almendras tostadas y caramelizadas.",
"active": true
}, {
"id": "f3OV7BBi6R7MfmFaiS8Y",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "DULCE DE LECHE BLEND",
"description": "Dulce de leche logrado con la combinación justa de los mejores dulces de leche artesanales del país.",
"active": true
}, {
"id": "GQm8WQWgkQ1SCI8ufTKk",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "FRAMBUESA CON CHOCOLATES",
"description": "Frambuesas naturales licuadas y mixeadas con chocolates dulces blanco y negro.",
"active": true
}, {
"id": "WwF9ImDsleAfGfItXTX5",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "FRUTILLA A LA CREMA",
"description": "Crema de frutillas frescas, maceradas y licuadas.",
"active": true
}, {
"id": "fJOL9dF9YVWNdOeIiuhl",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "GRANIZADO",
"description": "Crema chantilly con veteado de chocolate semi amargo 70% fundido.",
"active": true
}, {
"id": "WiDBnYz6hNHHMssPtEtp",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "LEMON PIE",
"description": "Crema de jugo de limones naturales veteada con curd de limón, merengue suizo y trozos de galletas.",
"active": true
}, {
"id": "TwNYSMBLifcDSKpS4kgO",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "LIMÓN AL AGUA",
"description": "Exprimido de limones naturales.",
"active": true
}, {
"id": "31SfFyZVydH6uNQ1LIRG",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "MANGO MARACUYÁ",
"description": "Mango y maracuyá naturales licuados.",
"active": true
}, {
"id": "5PIaMg7cAjvciHIktWD8",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "MIX PATAGÓNICO",
"description": "Frambuesas, arándanos y moras naturales licuadas.",
"active": true
}, {
"id": "jWNlz28hBjV3kdkz2C9m",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "VAINILLA",
"description": "Crema con yema de huevo, infusionada con chauchas de vainilla.",
"active": true
}, {
"id": "Fr3beUFh0T6Bqwm3lVHT",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "TRAMONTANA",
"description": "Crema chantilly veteado con dulce de leche artesanal y galletas recubiertas de chocolate.",
"active": true
}, {
"id": "biPRCHvS0br2AW0TO7J7",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "SAMBAYÓN",
"description": "Tradicional postre italiano a base de yemas de huevo infusionada en chauchas de vainilla con agregado de vino.",
"active": true
}, {
"id": "8YrhDMhQFHVOwli3dAsH",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "PITACCHIO",
"description": "Crema a base de pistachos naturales tostados y molidos.",
"active": true
}, {
"id": "u40LlQow4q3XzyHiL5uX",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "NARANJA DURAZNO",
"description": "Exprimido de naranjas y duraznos naturales.",
"active": true
}]
}]
}, {
"id": "1Xtvbgb3mtGvMsEOEYr5",
"categoryId": "4eGfKX6XdPnUaQdaFcuS",
"name": "1/2 KILO",
"price": 1700,
"active": true,
"linkedOptionIds": ["Cjpu19tmyI1xCuHrOraG"],
"options": [{
"id": "Cjpu19tmyI1xCuHrOraG",
"name": "Sabores 1/2 KG",
"rangeType": "range",
"min": 1,
"max": 3,
"displayItemQuantities": false,
"linkedItemIds": ["uUqAXAkllUerQIoMwtCO", "A77fJMUVdP1rIRIYVT4L", "LkLwLfMJSeRUjlPsdjuU", "f3OV7BBi6R7MfmFaiS8Y", "GQm8WQWgkQ1SCI8ufTKk", "WwF9ImDsleAfGfItXTX5", "fJOL9dF9YVWNdOeIiuhl", "WiDBnYz6hNHHMssPtEtp", "TwNYSMBLifcDSKpS4kgO", "31SfFyZVydH6uNQ1LIRG", "5PIaMg7cAjvciHIktWD8", "jWNlz28hBjV3kdkz2C9m", "Fr3beUFh0T6Bqwm3lVHT", "biPRCHvS0br2AW0TO7J7", "8YrhDMhQFHVOwli3dAsH", "u40LlQow4q3XzyHiL5uX"],
"items": [{
"id": "uUqAXAkllUerQIoMwtCO",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "COCO CON DULCE DE LECHE",
"description": "Crema infusionada de coco rallado veteado con dulce de leche artesanal.",
"active": true
}, {
"id": "A77fJMUVdP1rIRIYVT4L",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "CREMA CHANTILLY",
"description": "La tradicional crema chantilly hecha helado.",
"active": true
}, {
"id": "LkLwLfMJSeRUjlPsdjuU",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "CREMA DE ALMENDRAS",
"description": "Crema con almendras tostadas y caramelizadas.",
"active": true
}, {
"id": "f3OV7BBi6R7MfmFaiS8Y",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "DULCE DE LECHE BLEND",
"description": "Dulce de leche logrado con la combinación justa de los mejores dulces de leche artesanales del país.",
"active": true
}, {
"id": "GQm8WQWgkQ1SCI8ufTKk",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "FRAMBUESA CON CHOCOLATES",
"description": "Frambuesas naturales licuadas y mixeadas con chocolates dulces blanco y negro.",
"active": true
}, {
"id": "WwF9ImDsleAfGfItXTX5",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "FRUTILLA A LA CREMA",
"description": "Crema de frutillas frescas, maceradas y licuadas.",
"active": true
}, {
"id": "fJOL9dF9YVWNdOeIiuhl",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "GRANIZADO",
"description": "Crema chantilly con veteado de chocolate semi amargo 70% fundido.",
"active": true
}, {
"id": "WiDBnYz6hNHHMssPtEtp",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "LEMON PIE",
"description": "Crema de jugo de limones naturales veteada con curd de limón, merengue suizo y trozos de galletas.",
"active": true
}, {
"id": "TwNYSMBLifcDSKpS4kgO",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "LIMÓN AL AGUA",
"description": "Exprimido de limones naturales.",
"active": true
}, {
"id": "31SfFyZVydH6uNQ1LIRG",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "MANGO MARACUYÁ",
"description": "Mango y maracuyá naturales licuados.",
"active": true
}, {
"id": "5PIaMg7cAjvciHIktWD8",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "MIX PATAGÓNICO",
"description": "Frambuesas, arándanos y moras naturales licuadas.",
"active": true
}, {
"id": "jWNlz28hBjV3kdkz2C9m",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "VAINILLA",
"description": "Crema con yema de huevo, infusionada con chauchas de vainilla.",
"active": true
}, {
"id": "Fr3beUFh0T6Bqwm3lVHT",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "TRAMONTANA",
"description": "Crema chantilly veteado con dulce de leche artesanal y galletas recubiertas de chocolate.",
"active": true
}, {
"id": "biPRCHvS0br2AW0TO7J7",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "SAMBAYÓN",
"description": "Tradicional postre italiano a base de yemas de huevo infusionada en chauchas de vainilla con agregado de vino.",
"active": true
}, {
"id": "8YrhDMhQFHVOwli3dAsH",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "PITACCHIO",
"description": "Crema a base de pistachos naturales tostados y molidos.",
"active": true
}, {
"id": "u40LlQow4q3XzyHiL5uX",
"categoryId": "ITGx6prFC5a3AZ6fiFjR-items",
"name": "NARANJA DURAZNO",
"description": "Exprimido de naranjas y duraznos naturales.",
"active": true
}]
}]
}]
}, {
"id": "t35dHnUAaD0DCKrQFsow",
"name": "PALETAS",
"image": "<https://cdn.pedix.app/ITGx6prFC5a3AZ6fiFjR/categories/1678472606307.png?size=250&quality=80&env=development>",
"active": true,
"products": [{
"id": "47kq7jbKCA5qN0E0Cl8S",
"categoryId": "t35dHnUAaD0DCKrQFsow",
"name": "DULCE DE LECHE DELIZIA",
"description": "Helado de Dulce de Leche + Relleno de Dulce de Leche + Bañado en Chocolate Semiamargo\\n\\n",
"price": 900,
"active": true,
"options": []
}, {
"id": "iLB0xcODlDTUVH5wPctZ",
"categoryId": "t35dHnUAaD0DCKrQFsow",
"name": "GIANDUIA",
"description": "Helado de Avellanas + Bañado en Chocolate Gianduia + Trozos de Almendras Caramelizadas\\n",
"price": 900,
"active": true,
"options": []
}]
}, {
"id": "6deai91vdAWXcFsrKZh1",
"name": "CUCURUCHOS",
"image": "<https://cdn.pedix.app/ITGx6prFC5a3AZ6fiFjR/categories/1678473083760.png?size=250&quality=80&env=development>",
"active": true,
"products": [{
"id": "2tsxR9GHhGVq6uosiY35",
"categoryId": "6deai91vdAWXcFsrKZh1",
"name": "BLISTER X3 CUCURUCHOS",
"price": 200,
"active": true
}]
}]
}
}
El sistema deberá desarrollar un endpoint para recibir las notificaciones de nuevos pedidos enviadas por Pedix.
Para enviar las notificaciones de nuevos pedidos desde Pedix a el sistema, utilizaremos la funcionalidad de pub/sub de gcloud. Esto nos permite un sistema de mensajería asincrónica para la comunicación entre aplicaciones.
Cuando se genere un nuevo pedido en Pedix, un mensaje se publicará automáticamente en un tema específico de pub/sub. Para recibir las notificaciones en tiempo real, el sistema deberá proporcionar un Endpoint REST que nosotros configuraremos para que nuestro webhook se encargue de llamarlo automáticamente con el payload correspondiente.