Documentación - Contenedor 'clasificacion'

Introducción

El arbol de clasificaciones es jerárquico. Cada clasificación tiene un padre y puede tener hijos.
Las clasificaciones de primer nivel no tienen padre, pero sí tienen una familia a las cuales pertenecen.

Para recuperar una clasificación en particular hay varios recursos disponibles en el contenedor clasificacion:
- data: contiene los datos básicos de la clasificación
- hijos: contiene la lista de las clasificaciones de primer nivel en esta clasificación
- landpage: contiene los datos completos del landpage de la clasificación
- mdata: contiene los datos básicos de la clasificación para mobile (resumido)
- mlandpage: contiene los datos completos del landpage para la APP
- mrecetas: contiene la lista de recetas, paginada, de esta clasificación

Recurso 'data'

Los datos básicos de una clasificación se obtienen consumiendo el recurso siguiente:

[GET] /v2/clasificacion/:Clave/data.json

:Clave es la clave del recurso solicitado.

El sistema regresará los datos de la clasificación solicitada:

{
  "clave":1,
  "familia":"rec",
  "padre":null,
  "virtual":null,
  "orden":1,
  "estatus":1,
  "estatusapp":1,
  "nombre":"Postres",
  "titulo":"Recetas de Postres",
  "htmltitle":"Recetas de Postres",
  "link":"postres",
  "ruta":"\/recetas\/postres",
  "palabras":"\u00bfEst\u00e1s buscando recetas de Postres? Kiwilimon tiene las mejores recetas de pasteles, pays y gelatinas probadas con calificaciones, comentarios, tips y videos.",
  "destacada":22521,
  "imagentitulo":"Recetas de Postres",
  "imagen":"1.jpg",
  "extra1":"",
  "extra2":"",
  "extra3":"",
  "extra4":"",
  "extra5":"",
  "lastmodif":"2013-04-18T13:32:46.00-06",
  "lastuser":9,
  "plantilla":"",
  "plantillaparams":"sinmarca=1",
  "titulo_uno":"",
  "cuerpo_uno":"",
  "titulo_dos":"",
  "cuerpo_dos":"",
  "icono":"i1.png",
  "recetasrecomendadas":"15658,894",
  "view":106755,
  "cantidadsubclasificaciones":15,
  "cantidadrecetas":1615,
  "favoritos":0,
  "publicidadsalto":7
}

Los campos a considerar son:
clave: la clave interna de referencia de la clasificación en el GRAPH.
familia: la familia de la clasificación.
padre: el padre de esta clasificación o vacio si no tiene padre.
virtual: la clave de la clasificación correspondiente si es una clasificación virtual (hace un redirect a la nueva).
orden: el orden de la clasificación relativ a sus hermanas.
estatus: el estatus de la clasificación. Siempre será 1 ya que solo las clasificaciones publicadas son visibles en el GRAPH.
estatusapp: el estatus de la clasificación para publicar hacia la APP. Siempre será 1 en el servicio 'mdata', ya que solo las clasificaciones publicadas son visibles en el GRAPH para el APP, y puede ser 0 o 1 en 'data'.
nombre: el nombre de la clasificación.
titulo: el titulo usado para H1 en la página.
htmltitle: el titulo usado para el HTML de la página.
link: es el link unico de la clasificación.
ruta: es la ruta de acceso a la clasificación en el sitio.
palabras: es la descripción usada para los metatags de la página.
destacada: es la clave de la receta más destacada de esta clasificación. Opcional.
imagentitulo: el titulo debajo de la imagen de la clasificación.
imagen: El archivo de la imagen. Esta físicamente ubicada en http://cdn.kiwilimon.com/el titulo usado para H1 en la página.
extra1: Algún valor extra (usado en casos específicos).
extra2: Algún valor extra (usado en casos específicos).
extra3: Algún valor extra (usado en casos específicos).
extra4: Algún valor extra (usado en casos específicos).
extra5: Algún valor extra (usado en casos específicos).
lastmodif: Fecha del último cambio en la clasificación.
lastuser: Usuario que cambión la clasificación la última vez.
plantilla: Plantilla a usar para presentar la clasificación.
plantillaparams: Lista de parámetros para la plantilla.
titulo_uno: el titulo usado para menús.
cuerpo_uno: datos usados para menús.
titulo_dos: el titulo usado para menús.
cuerpo_dos: datos usados para menús.
icono: el ícono usado para menús.
recetasrecomendadas: claves de las recetas que se recomiendan en prioridad en esta clasificación.
view: es la cantidad de veces que se ha visualizado esta clasificación.
cantidadsubclasificaciones: es la cantidad de subclasificaciones dentro de esta clasificación.
cantidadrecetas: es la cantidad de recetas dentro de esta clasificación.
favoritos: es la cantidad de personas que tiene esta clasificación como favorita.
publicidadsalto: es la cantidad de recetas que hay que saltar entre cada centillo de publicidad.

Recurso 'hijos'

Los datos básicos de las clasificaciones hijas de una familia se obtienen consumiendo el recurso siguiente:

[GET] /v2/clasificacion/:Clave/hijos.json

:Clave es la clave del recurso solicitado.

El sistema regresará los datos de la clasificacion solicitada con el arreglo de clasificaciones hijas:

{ CLASIFICACION,
  "subclasificaciones":
  [
    {CLASIFICACION-1},  
    {CLASIFICACION-2},  
    ...
  ]
}

CLASIFICACION es el arreglo de la clasificación principal solicitada, correspondiente al recurso 'data'.
{CLASIFICACION-n} representa el objecto básico data de las clasificaciones correspondiente al recurso 'data' de cada hijo.
Las clasificaciones estan ordenadas por el campo 'orden' de cada clasificación.

Recurso 'landpage'

Los datos básicos de las subclasificaciones hijas de primer nivel y de segundo nivel de una clasificación se obtienen consumiendo el recurso siguiente:

[GET] /v2/clasificacion/:Clave/landpage.json

:Clave es la clave del recurso solicitado.

El sistema regresará los datos de la clasificación solicitada agregado de las clasificaciones hijas y nietas, así como de las recetas correspondientes a cada subclasificación, pero con un límite de 4 en cantidad:

{ CLASIFICACION,
  "subclasificaciones":
  [
    {CLASIFICACION-1
     "subclasificaciones": 
     [
       {SUBCLASIFICACION-1},
       {SUBCLASIFICACION-2},
       ...
     ],
     "recetas":
     [
       {RECETARESUMEN-1},
       {RECETARESUMEN-2},
       ...
     ]
    },  
    ...
  ]
}

CLASIFICACION es el arreglo de la clasificación básica.
{CLASIFICACION-n} representa el objecto básico data de una clasificación (ver capítulo 'Clasificaciones').
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 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, con prioridad a las subclasificaciones sobre las recetas.

Recurso 'mdata'

Los datos básicos de una clasificación para APP mobile se obtienen consumiendo el recurso siguiente:

[GET] /v2/clasificacion/:Clave/mdata.json

:Clave es la clave del recurso solicitado.

El sistema regresará los datos resumidos de la clasificación solicitada:

{
  "clave":1,
  "orden":1,
  "nombre":"Postres",
  "imagen":"1.jpg",
  "destacada":22521,
  "cantidadsubclasificaciones":15,
  "cantidadrecetas":1615,
  "publicidadsalto":7
}

Los campos a considerar son:
clave: la clave interna de referencia de la clasificación en el GRAPH.
orden: la clave interna de referencia de la clasificación en el GRAPH.
nombre: el nombre de la clasificación.
virtual: la clave de la clasificación correspondiente si es una clasificación virtual (hace un redirect a la nueva).
imagen: el titulo usado para H1 en la página.
destacada: es la clave al pasillo descrito en el capítulo anterior.
cantidadsubclasificaciones: es la cantidad de recetas que usan este ingrediente.
cantidadrecetas: es la cantidad de recetas que usan este ingrediente.
publicidadsalto: es la cantidad de recetas que usan este ingrediente.

Recurso 'mlandpage'

Los datos básicos resumidos para APP mobile de las subclasificaciones hijas de primer nivel y de segundo nivel de una clasificación se obtienen consumiendo el recurso siguiente:

[GET] /v2/clasificacion/:Clave/mlandpage.json

{ CLASIFICACION,
  "subclasificaciones":
  [
    {CLASIFICACION-1
     "subclasificaciones": 
     [
       {SUBCLASIFICACION-1,
        "recetas":
        [
          {RECETARESUMEN-1},
          {RECETARESUMEN-2},
          ...
        ]
       },
       {SUBCLASIFICACION-2,
        "recetas":
        [
          {RECETARESUMEN-1},
          {RECETARESUMEN-2},
          ...
        ]
       },
       ...
     ],
     "recetas":
     [
       {RECETARESUMEN-1},
       {RECETARESUMEN-2},
       ...
     ]
    },  
    ...
  ]
}

CLASIFICACION es el arreglo de la clasificación básica del recurso 'mdata'.
{CLASIFICACION-n} representa el objecto básico 'mdata' de una clasificación.
Las clasificaciones estan ordenadas por el campo 'orden' de cada clasificación.
{SUBCLASIFICACION-n} representa el objecto básico mdata de una clasificación.
Las subclasificaciones estan ordenadas por el campo 'orden' de cada clasificación.
{RECETARESUMEN-n} representa el objecto mresumen de una receta (ver capítulo 'receta').
Las recetas estan ordenadas por el campo 'fecha' de cada receta en orden inverso (más recientes primero).

La cantidad máxima de RECETARESUMEN suma 9 máximo, con opción a ir a buscar más a través del recurso 'mrecetas'.

Es un objeto grande por esencia (approx 1.2 megas) pero cubre la casi totalidad de clasificaciones de nivel 1 para navegación de la APP. Se puede cachear 24 horas máximo en la APP.

Recurso 'mrecetas'

La lista de recetas paginada de una clasificación para APP mobile se obtiene consumiendo el recurso siguiente:

[GET] /v2/clasificacion/:Clave/:Primero/:Cantidad/mrecetas.json

Con ordenamiento:

[GET] /v2/clasificacion/:Clave/:Primero/:Cantidad/:orden/mrecetas.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.
:orden: es el campo de ordenamiento (opcional). Si este campo esta omitido, el sistema regresa el ordenamiento por defecto que es por fecha más reciente.
Valores posibles del ordenamiento:
nuevo: (por defecto) la primeras recetas son las más recientes.
comentado: regresa las recetas las más comentadas primero.
recomendado: regresa las recetas más recomendadas primero.
facil: regresa las recetas más fáciles y rápidas primero.
video: regresa las recetas con video primero (y por fechas más recientes primero).

El sistema regresará la lista de recetas de la clasificación solicitada:

[
  {RECETA-1},
  {RECETA-2},
  ...
]

Donde:
RECETA-n: es el recurso 'mresumen' de una receta (ver capítulo 'receta').
Si queremos un espacio de ad premium, entonces el sistema regresará un arreglo de la manera siguiente, en lugar de la receta:

{
  adpremium: 1,
  adclave: [clave] o NULL
}

adpremium: es una bandera, siempre a 1.
adclave: es la clave del producto por vender que queremos poner aqui. Es opcional, es decir que si no hay clave, usa un algoritmo aleatorio para escoger un ad desde la lista de ads disponibles (servicio porcomprar).
Si hay varios ads premiums en una pantalla, entonces el algoritmo aleatorio/forzado por clave debe de funcionar de manera inteligente y no repetir los ads hasta agotar las posibilidades.