Introducción
El contenedor contiene toda la información necesaria de una
familia de recetas.
Existen 5 recursos:
- data: datos básicos de una familia en particular.
- hijos: datos de las clasificaciones de primer nivel contenidas en esta familia.
- landpage: datos para armar una página de web o APP con toda la información resumida.
- mdata: datos básicos compactos para APP.
- mhijos: datos básicos compactos para la APP con los hijos.
Recurso 'data'
Los datos básicos de una familia se obtienen consumiendo el recurso siguiente:
[GET] /v2/familia/:Clave/data.json
:Clave es la clave del recurso solicitado, que se pueden obtener consumiendo el recurso 'familias'.
El sistema regresará los datos de la familia solicitada:
{ "clave":"rec",
"orden":1,
"nombre":"Recetas",
"estatus":1,
"link":"recetas",
"titulo":"Conoce nuestras deliciosas recetas",
"palabras":"\u00bfEstas buscando recetas de cocina? Kiwilimon tiene las mejores recetas de cocina probadas con calificaciones, comentarios, tips y videos.",
"lastmodif":"2014-11-19T12:08:39.00-06",
"lastuser":1,
"imagen":"rec.jpg",
"plantilla":"",
"plantillaparams":"",
"ruta":"\/recetas",
"icono":"",
"recetasrecomendadas":"",
"view":166073,
"cantidadclasificaciones":14
}
Los campos son:
clave: la clave interna de referencia de la familia en el GRAPH.
orden: número de orden. Normalmente el arreglo viene ordenado por este campo.
nombre: el nombre de la familia de clasificaciones.
estatus: el estatus de la familia. Siempre será 1 ya que solo las familias publicadas son visibles en el GRAPH.
link: es la liga básica para calcular la URL de la familia.
titulo: es el título HTML de la página referencia (land-page) de la familia.
palabras: es le meta tag "description" de la página referencia (land-page) de la familia.
lastmodif: es al ultima modificacion a estos datos.
lastuser: es el usuario que modifico estos datos la ultima vez.
imagen: es la imagen de la familia. Es opcional.
plantilla: es una posible plantilla alterna para usar con esta familia. Es opcional.
plantillaparams: son los parametros para aplicar a la plantilla precedente. Es opcional.
icono: es el icono de la familia. Es opcional.
recetasrecomendadas: es la lista de recetas recomendadas para esta familia de recetas. Estas aparecen en prioridad en el despliegue de las recetas de la familia. Es opcional.
view: es la cantidad de veces que se ha visualizado esta familia como dato completo.
ruta: es la ruta completa de la URL para acceder la página referencia (land-page) de la familia. Hay que agregar http://www.kiwilimon.com antes para acceder desde afuera del sitio.
cantidadclasificaciones: es la cantidad de clasificaciones publicadas en esta familia.
Recurso 'hijos'
Los datos básicos agregados de las clasificaciones hijas de una familia se obtienen consumiendo el recurso siguiente:
[GET] /v2/familia/:Clave/hijos.json
:Clave es la clave del recurso solicitado.
El sistema regresará los datos de la familia solicitada con el arregle de clasificaciones hijas:
{ FAMILIA,
"clasificaciones":
[
{CLASIFICACION-1},
{CLASIFICACION-2},
...
]
}
FAMILIA es el arreglo de la familia básica, obtenida por el recurso 'data'.
{CLASIFICACION-n} representa el objecto básico
data de una clasificación (ver capítulo 'Clasificacion').
Las clasificaciones estan ordenadas por el campo 'orden' de cada clasificación.
Recurso 'landpage'
Los datos básicos agregados de las clasificaciones hijas de primer nivel y de segundo nivel de una familia se obtienen consumiendo el recurso siguiente:
[GET] /v2/familia/:Clave/landpage.json
:Clave es la clave del recurso solicitado.
NOTA IMPORTANTE:
Si la clave es "appletv" entonces el sistema regresará las clasificaciones y recetas para la APP de appleTV. No necesita identificar el usuario para esta operación.
El sistema regresará los datos de la familia solicitada agregado de las clasificaciones hijas y nietas, así como de las recetas correspondientes a cada clasificación, pero con un límite de 4 en cantidad:
{ FAMILIA,
"clasificaciones":
[
{CLASIFICACION-1
"subclasificaciones":
[
{SUBCLASIFICACION-1},
{SUBCLASIFICACION-2},
...
],
"recetas":
[
{RECETARESUMEN-1},
{RECETARESUMEN-2},
...
]
},
...
]
}
FAMILIA es el arreglo de la familia básica obtenido por el recurso 'data'.
{CLASIFICACION-n} representa el objecto básico
data de una clasificación (ver capítulo 'Clasificacion').
Las clasificaciones estan ordenadas por el campo 'orden' de cada clasificación.
{SUBCLASIFICACION-n} representa el objecto básico
data de una clasificación (ver capítulo 'Clasificaciones').
Las sub-clasificaciones estan ordenadas por el campo 'orden' de cada clasificación.
{RECETARESUMEN-n} representa el objecto
resumen de una receta (ver capítulo 'Recetas').
Las recetas estan ordenadas por el campo 'fecha' de cada receta en orden inverso (más recientes primero).
La cantidad de SUBCLASIFICACION y RECETARESUMEN suma 4 máximo.
Recurso 'mdata'
Los datos básicos compactos para APP de una familia se obtienen consumiendo el recurso siguiente:
[GET] /v2/familia/:Clave/mdata.json
:Clave es la clave del recurso solicitado, que se pueden obtener consumiendo el recurso 'familias'.
El sistema regresará los datos de la familia solicitada, que es un sub conjunto de datos del recurso básico 'data':
{ "clave":"rec",
"nombre":"Recetas",
"imagen":"rec.jpg",
"cantidadclasificaciones":14
}
Los campos son:
clave: la clave interna de referencia de la familia en el GRAPH.
nombre: el nombre de la familia de clasificaciones.
imagen: es la imagen de la familia. Es opcional.
cantidadclasificaciones: es la cantidad de clasificaciones publicadas en esta familia.
Recurso 'mhijos'
Los datos básicos compactos para APP de las clasificaciones hijas de una familia se obtienen consumiendo el recurso siguiente:
[GET] /v2/familia/:Clave/mhijos.json
:Clave es la clave del recurso solicitado.
El sistema regresará los datos de la familia solicitada con el arregle de clasificaciones hijas:
{ FAMILIA,
"publicidadsalto": 7,
"clasificaciones":
[
{CLASIFICACION-1},
{CLASIFICACION-2},
...
]
}
FAMILIA es el arreglo de la familia básica obtenida por el recurso 'mdata'.
{CLASIFICACION-n} representa el objecto básico
mdata de una clasificación (ver capítulo 'Clasificacion').
Las clasificaciones estan ordenadas por el campo 'orden' de cada clasificación.
El campo
publicidadsaldo indica cada cuanta receta/clasificacion hay un banner insertado en esta familia de recetas.
Además, {CLASIFICACION-n} puede representar un botón especial con la estructura siguiente (diferente de un objeto 'mdata' de clasificación):
{ "clave": "boton1",
"boton": 1,
"nombre": "Postres",
"imagen": "1.jpg",
"url": "http://www.kiwilimon.com/recetas/postres"
}
Este botón se presenta de la misma manera que una clasificación pero tiene la diferencia en la respuesta al tocarlo: en lugar de abrir una sub-clasificación, salta a un sitio web externo.
Los campos son:
-
clave: ID único de este botón.
-
boton: es una bandera puesta a 1 si el objeto no es una clasificación pero un botón. Se tiene que diferenciar un botón de una clasificación con la presencia de este campo.
-
nombre: el nombre del botón.
-
imagen: la imagen para el botón.
-
url: la URL a la cual saltar cuando se solicita el acceso al browser.
Ejemplos
Datos básicos de la familia 'recetas' en JSON:
[GET] /v2/familia/rec/data.json
Resultado:
{ "clave":"rec",
"orden":1,
"nombre":"Recetas",
"estatus":1,
"link":"recetas",
"titulo":"Conoce nuestras deliciosas recetas",
"palabras":"\u00bfEstas buscando recetas de cocina? Kiwilimon tiene las mejores recetas de cocina probadas con calificaciones, comentarios, tips y videos.",
"ruta":"\/recetas",
"cantidadclasificaciones":14
}
Datos con hijos de la familia 'preferencias' en XML:
[GET] /v2/familia/pref/hijos.xml
Resultado:
<?xml version="1.0" encoding="UTF-8" ?>
<familia>
<clave>pref</clave>
<orden>4</orden>
<nombre>Preferencia</nombre>
<estatus>1</estatus>
<link>preferencia</link>
<titulo></titulo>
<palabras></palabras>
<ruta>/preferencia</ruta>
<cantidadclasificaciones>14</cantidadclasificaciones>
<clasificaciones>
<record id="0">
<clave>3011</clave>
<familia>pref</familia>
<padre></padre>
<orden>3011</orden>
<estatus>1</estatus>
<nombre>Recetas de Diabetes</nombre>
<titulo>Recetas de Diabetes</titulo>
<link>recetas-diabetes</link>
<palabras>¿Estás buscando recetas de Diabetes? Kiwilimon tiene las mejores recetas de Diabetes probadas con calificaciones, comentarios, tips y videos.</palabras>
<destacada></destacada>
<imagentitulo>Recetas de Diabetes</imagentitulo>
<imagen>3011.jpg</imagen>
<extra1></extra1>
<extra2></extra2>
<extra3></extra3>
<extra4></extra4>
<extra5></extra5>
<ruta>/preferencia/recetas-diabetes</ruta>
<cantidadclasificaciones>6</cantidadclasificaciones>
<cantidadrecetas>490</cantidadrecetas>
</record>
<record id="1">
<clave>4001</clave>
<familia>pref</familia>
<padre></padre>
<orden>4001</orden>
<estatus>1</estatus>
<nombre>Recetas para Niños</nombre>
<titulo>Recetas de Recetas para Niños</titulo>
<link>ninos</link>
<palabras>¿Estás buscando recetas de Niños? Kiwilimon tiene las mejores recetas de Niños probadas con calificaciones, comentarios, tips y videos.</palabras>
<destacada></destacada>
<imagentitulo>Recetas de Recetas para Niños</imagentitulo>
<imagen>4001.jpg</imagen>
<extra1></extra1>
<extra2></extra2>
<extra3></extra3>
<extra4></extra4>
<extra5></extra5>
<ruta>/preferencia/ninos</ruta>
<cantidadclasificaciones>0</cantidadclasificaciones>
<cantidadrecetas>503</cantidadrecetas>
</record>
...etc...
</clasificaciones>
</familia>
Datos del land page de la familia 'tipos de cocina' en XML:
[GET] /v2/familia/coc/landpage.xml
Resultado:
<?xml version="1.0" encoding="UTF-8" ?>
<familia>
<clave>coc</clave>
<orden>2</orden>
<nombre>Tipo de cocina</nombre>
<estatus>1</estatus>
<link>tipo-de-cocina</link>
<titulo></titulo>
<palabras></palabras>
<ruta>/tipo-de-cocina</ruta>
<cantidadclasificaciones>22</cantidadclasificaciones>
<clasificaciones>
<record id="0">
<clave>2001</clave>
<familia>coc</familia>
<padre></padre>
<orden>2001</orden>
<estatus>1</estatus>
<nombre>Mexicana</nombre>
<titulo>Recetas Mexicanas</titulo>
<link>mexicana</link>
<palabras>Si estás buscando recetas de comida mexicana, descubre todas las opciones que tenemos para ti. Desde los antojitos mexicanos hasta sopas y platillos tradicionales. </palabras>
<destacada>0</destacada>
<imagentitulo>Recetas Mexicanas</imagentitulo>
<imagen>2001.jpg</imagen>
<extra1></extra1>
<extra2></extra2>
<extra3></extra3>
<extra4></extra4>
<extra5></extra5>
<ruta>/tipo-de-cocina/mexicana</ruta>
<cantidadclasificaciones>6</cantidadclasificaciones>
<cantidadrecetas>1670</cantidadrecetas>
<cantidadsubclasificaciones>6</cantidadsubclasificaciones>
<subclasificaciones>
<record id="0">
<clave>2002</clave>
<familia>coc</familia>
<padre>2001</padre>
<orden>2002</orden>
<estatus>1</estatus>
<nombre>Antojitos Mexicanos</nombre>
<titulo>Recetas de Antojitos Mexicanos</titulo>
<link>antojitos-mexicanos</link>
<palabras>¿Estás buscando recetas de Antojitos Mexicanos? Kiwilimon tiene las mejores recetas de Antojitos Mexicanos probadas con calificaciones, comentarios, tips y videos.</palabras>
<destacada></destacada>
<imagentitulo>Recetas de Antojitos Mexicanos</imagentitulo>
<imagen>2002.jpg</imagen>
<extra1></extra1>
<extra2></extra2>
<extra3></extra3>
<extra4></extra4>
<extra5></extra5>
<ruta>/tipo-de-cocina/mexicana/antojitos-mexicanos</ruta>
</record>
<record id="1">
<clave>2003</clave>
<familia>coc</familia>
<padre>2001</padre>
<orden>2003</orden>
<estatus>1</estatus>
<nombre>Sopas Mexicanas</nombre>
<titulo>Recetas de Sopas Mexicanas</titulo>
<link>sopas-mexicanas</link>
<palabras>¿Estás buscando recetas de Sopas Mexicanas? Kiwilimon tiene las mejores recetas de Sopas Mexicanas probadas con calificaciones, comentarios, tips y videos.</palabras>
<destacada></destacada>
<imagentitulo>Recetas de Sopas Mexicanas</imagentitulo>
<imagen>2003.jpg</imagen>
<extra1></extra1>
<extra2></extra2>
<extra3></extra3>
<extra4></extra4>
<extra5></extra5>
<ruta>/tipo-de-cocina/mexicana/sopas-mexicanas</ruta>
</record>
...etc...
</record>
</clasificaciones>
</familia>
