Documentación de la API Búsqueda de Recetas

La API Edamam B2B es accesible enviando consultas HTTPS a una URL especifica como se describe a continuación. La URL base es https://api.edamam.com . Se obtiene la URL completa uniendo la ruta de la consulta a la URL base, de la siguiente manera https://api.edamam.com/search. En respuesta, la API retorna HTTP código 200 OK y el cuerpo contiene el resultado del requerimiento en formato JSON.

En caso de errores, la API retorna un código de error (por ejemplo, 404 NOT FOUND). El cuerpo puede contener información útil en formato HTML. Los programas cliente sólo deben usar los códigos de respuesta, así como los cuerpos se proporcionan para la comodidad de los desarrolladores cliente.

Compresión HTTP

Los servidores Edamam soportan la compresión estándar HTTP, usando gzip. El uso de la compresión reduce el tamaño de la respuesta y por consiguiente, incrementa la velocidad de transmisión.

El cliente puede incluir el siguiente encabezado, para indicar que método de compresión soporta:

Accept-Encoding: gzip

Entonces, el servidor incluirá el siguiente encabezado para indicar la respuesta de compresión

Content-Encoding: gzip

O lo omitirá si la respuesta no esta comprimida.

Para más información, vea aquí: http://en.wikipedia.org/wiki/Http_compression.

Interfaces

Buscador

Search

Ruta: https://test-es.edamam.com/search

El buscador en espanol todavia esta en beta. Para recetas en ingles puedes acceder al Path: https://api.edamam.com/search

Búsqueda de recetas que coinciden con la consulta específica. Ten cuidado de usar la idioma adequada para su cosnulta dependiende del access point que usas.

Los siguientes parámetros son parte de la URL de solicitud GET:

Parámetro Requerido Typo Descripción
app_id yes string Identificador de aplicación 3scale
app_key yes string Llave de aplicación 3scale
q no* string Texto de consulta (requerido) Por ejemplo q=pollo
from no integer Índice de primer resultado (por defecto=0). Ejemplo: Desde=20
to no integer Índice de último resultado (exclusivo, por defecto desde +10). Ejemplo: Hasta=30
diet no enum Etiqueta de Dieta: Uno de “balanceado”, “Alto en proteína”. “Alto en Fibra”, “Bajo en grasas”, “Bajo en carbohidratos”, “Bajo en sodio”
health no enum Health label: One of the Health api parameters listed in Diet and Health Labels table at the end of this documentation. For example “peanut-free”, “tree-nut-free”, “soy-free”, “fish-free”, “shellfish-free”
r no* string Regresa información acerca de una receta específica según su Identificador, es decir, r=http://www.edamam.com/ontologies/edamam.owl%23recipe_637913ec61d9da69eb451818c3293df2
calories no range Calorías por porción. El formato es “gte L, lte U”, donde los enteros L y U son los extremos superior e inferior respectivamente, para el rango de calorías deseado. Cualquier extremo puede ser omitido.
Ejemplos: “lte 600”, “gte 250”, “gte 250, lte 600”
returns no Hits Parámetros de consulta y resultados que coinciden
callback no string Parámetro de re consulta para JSONP. Se “empaquetará” el resultado en una función de consulta JavaScript para el callback específico. Opcional
*Exactamente uno de estos parámetros (q / r) deben estar presentes

Ejemplo de consulta GET

Ejemplo de consulta GET:

NOTA: Por favor asegurase que usa las credenciales exactas que creó para esta API tal que son para la aplicación y el plan específico.

Tipos

Los tipos compuestos son descritos en términos de su representación en JSON.

Para todas las descripciones, se usa la siguiente notación:
boolean, integer, float, and string permanecen para los tipos primitivos de Javascript Boolean, integer, float, and string, respectivamente enum permanece para un campo de texto donde sólo toma valores de un rango pre definido (el rango es especificado si es esencial) T permanece para un arreglo de objetos de tipo T
T[] permanece para un objeto (mapa asociado) donde cada campo (elemento) es del tipo T.

Campo Tipo Descripción
q string Texto en consulta, entregado
from integer Índice de primer resultado, entregado
to integer Índice se último resultado, entregado
params String[][] Parámetros efectivos
count integer Número de resultados encontrados
more boolean Más del máximo número de resultados permitidos
hits Recipe[] Resultados que coinciden (Objetos Receta )

Receta

_Nota: Sólo un subconjunto de los campos pueden estar presentes, dependiendo de la interfaz a través de la cual se obtiene la receta. Consulte la descripción de la interfaz específica para los detalles

Campo Tipo Descripción
uri string Identificador de ontología
label string Título de la receta
image string URL de la imagen
source string Identificador de sitio de origen
url string URL de la receta original
yield integer URL de la receta original
level enum Nivel de dificultad
summary string Breve descripción
calories float Total de energía, kcal
totalWeight float Peso total, g
ingredients Ingredient[] Lista de ingredientes
totalNutrients NutrientInfo[] Total de nutrientes por porción
totalDaily NutrientInfo[] % del valor diario por porción
dietLabels enum[] Etiquetas de dieta: “balanced”, “high-protein”, “high-fiber”, “low-fat”, “low-carb”, “low-sodium”
healthLabels enum[] Etiquetas de salud: “vegan”, “vegetarian”, “paleo”, “dairy-free”, “gluten-free”, “wheat-free”, “fat-free”, “low-sugar”, “egg-free”, “peanut-free”, “tree-nut-free”, “soy-free”, “fish-free”, “shellfish-free”

Ingredient

Campo Tipo Descripción
uri string Identificador de ontología
quantity float Cantidad de medida especificada
measure Measure Medida
weight float Peso total, g
food Food Comida

NutrientInfo

Campo Tipo Descripción
uri string Identificador de ontología
label string Etiqueta visualizada
quantity float Cantidad de unidades especificadas
unit string Unidades

Measure

Campo Tipo Descripción
uri string Identificador de ontología
label string Nombre común

Food

Campo Tipo Descripción
uri string Identificador de ontología
label string Nombre común

Etiquetas de Dieta y Salud

Tipo Etiqueta Web Parámetro API Definición
Diet High-protein high-protein Las proteínas proporcionan mas del 50% del total de calorías
Diet Low carb low-carb Los carbohidratos proporcionan menos del 20% del total de calorías
Diet Low fat low-fat Las grasas proporcionan menos del 15% del total de calorías
Diet Balanced balanced Los valores de Proteína/Grasa/Carbohidratos en razón de 15/35/50
Diet High fiber high-fiber Más de 5g de fibra por porción
Diet Low-Sodium low-sodium Menos de 140mg Na por porción
Health No-sugar low-sugar Sin azúcar natural – glucosa, dextrosa, galactosa, fructuosa, sacarosa, lactosa, maltosa
Health Sugar-conscious sugar-conscious Menos de 4g de azúcar por porción
Health n/a low-fat-abs Menos de 3g de grase por porción
Health Gluten gluten-free Sin ingredientes que contengan gluten
Health Vegetarian vegetarian No contiene carnes, aves o pescado
Health Vegan vegan No contiene, aves, pescado, lácteos, huevos o miel
Health Paleo paleo Se excluye lo que se percibe como productos agrícolas; granos, legumbres, productos lácteos, papas, sal refinada, azúcar refinada y aceites procesados
Health Wheat-free wheat-free Sin trigo, aunque puede tener gluten
Health Dairy dairy-free Sin lácteos, sin lactosa
Health Eggs egg-free Sin huevo o productos que contengan huevo
Health Soy soy-free Sin soya o productos que contengan soya
Health Fish fish-free Sin pescado o derivados de pescado
Health Shellfish shellfish-free Sin mariscos o productos derivados de los mariscos
Health Tree Nuts tree-nut-free Sin nueces o productos que contengan nueces
Health Low potassium low-potassium Menos de 150mg por porción
Health Alcohol-free alcohol-free No se usa alcohol o productos que contengan alcohol
Health No oil added No-oil-added No se agrega aceite excepto que lo contenga en los ingredientes básicos
Health Kidney friendly kidney-friendly Por porción – fósforo menos de 250 mg Y potasio menos de 500 mg Y sodio menos de 500 mg
Health Peanuts peanut-free Sin cacahuetes o productos que contengan cacahuetes
Health Alcohol alcohol-free La receta no usa o está hecha con bebidas alcoholicas