Documentación - Contenedor 'ingredientegrupo'

¿Buscas la Documentación API v1?

Grupo de ingredientes

El contenedor ingredientegrupo regresa la información de un grupo de ingredientes en particular así como la lista de ingredientes que lo conforman.

Hay dos recursos disponibles:
- mdata para obtener los datos del grupo de manera compacta para una APP
- mingredientes para obtener la lista de ingredientes del grupo (paginado) de manera compacta para una APP

Recurso 'mdata'

Los datos básicos de un grupo se obtienen consumiendo el recurso siguiente:
[GET] /v2/ingredientegrupo/:Clave/mdata.json
:Clave es la clave del recurso solicitado.

El sistema regresará los datos del grupo de ingredientes solicitado:
{ "clave":"0100",
  "nombre":"Productos L\u00e1cteos y Huevo",
  "imagen":"0100.png",
  "orden":1,
  "cantidadingredientes":322
}
Los campos son:
clave: la clave interna de referencia del grupo, que corresponde a la clave USDA.
nombre: el nombre del grupo de ingredientes.
imagen: la imagen correspondiente a este grupo. Si hay un valor en el campo, la imagen se encuentra en el CDN, en la ruta siguiente: cdn.kiwilimon.com/ingredientegrupo/:clave/:imagen
orden: número de orden. Normalmente el arreglo viene ordenado por este campo.
cantidadingredientes: es la cantidad de ingredientes publicados presentes en este grupo.

Recurso 'mingredientes'

La lista de ingredientes se obtiene consumiendo el recurso siguiente:
[GET] /v2/ingredientegrupo/:Clave/:Primero/:Cantidad/mingredientes.json
:Clave es la clave del recurso solicitado.
:Primero: es el primer objeto de la lista que necesitamos. 0 indica que no hay offset y apunta el primero de la lista. De 1 en adelante es un offset para saltar cantidad de objetos en la lista total.
:Cantidad: es la cantidad de objetos que queremos regresar a partir del "primero" solicitado.

El sistema regresará la lista de ingredientes del grupo de ingredientes solicitado:
[
  {INGREDIENTE-1},
  {INGREDIENTE-2},
  ...
]
Donde:
INGREDIENTE-n: es el recurso mdata de un ingrediente (ver capítulo 'ingrediente').

Ejemplos

Datos básicos del grupo '0100' en JSON:
[GET] /v2/ingredientegrupo/0100/mdata.json
Resultado:
{
  "clave":"0100",
  "nombre":"Productos L\u00e1cteos y Huevo",
  "imagen":"0100.png",
  "orden":1,
  "cantidadingredientes":0
}
Los 5 primeros ingredientes del grupo '0100' en JSON:
[GET] /v2/ingredientegrupo/0100/0/5/mingredientes.json
Resultado:
[
  {"clave":1859,"orden":null,"nombre":"cool whip","imagen":"","pasillo":90,"grupo":"0100"},
  {"clave":1883,"orden":null,"nombre":"cream whipped","imagen":"","pasillo":90,"grupo":"0100"},
  {"clave":459,"orden":null,"nombre":"crema","imagen":"","pasillo":90,"grupo":"0100"},
  {"clave":462,"orden":null,"nombre":"crema \u00e1cida baja en grasa","imagen":"","pasillo":90,"grupo":"0100"},
  {"clave":1869,"orden":null,"nombre":"crema agria","imagen":"","pasillo":90,"grupo":"0100"}
]