API Documentation

Version 1.4

Available API methods

Resources
Recipe List
Recipe Detail
Recipe Search
Recipe Category List
Special Offer List
Store Location List
Recipe Rating

Resources

GET /api/v1.4/resources

Returns list of resources. This is used in recipe app. Make Example Call

Request

Parameter	Type	Description
format	string	Available values: json or xml
api_key	string	identify API consumer, testing with: abcdefgh

Response

Parameter	Type	Description
recipe_list	string	Latest URL for recipe_list method
recipe_category_list	string	Latest URL for recipe_category_list method
special_offer_list	string	Latest URL for special_offer_list method
store_location_list	string	Latest URL for store_location_list method
recipe_rating	string	Latest URL for recipe_rating method
css	string	Latest URL for CSS file used in recipe app web view.
iphone_download_url	string	Link to published app in Apple App Store
android_download_url	string	Link to published app on Google Play
landing_page	string	Latest URL for css file used in recipe app.
theme_version	int	Theme for Recipe App
data_version	int	Helps to utilise cache
background_images	string	Theme for Recipe App
background_main	string	Theme for Recipe App
background_invisible_header	string	Theme for Recipe App
background_empty_shopping_list	string	Theme for Recipe App
mail_template_images	string	Theme for Recipe App.

Recipe List

GET /api/v1.4/recipe_list

Returns list of recipes. Make Example Call

Request

Parameter	Type	Description
format	string	Available values: json or xml
api_key	string	identify API consumer, testing with: abcdefgh
thumbnail_size	int	optional parameter, requested thumbnail size in pixels, has to be a multiple of 5, e.g. 645, not 639

Response

Array where each item is recipe_detail

Recipe Detail

GET /api/v1.4/recipe_detail

Returns detail of single recipe. Make Example Call

Request

Parameter	Type	Description
format	string	Available values: json or xml
api_key	string	identify API consumer, testing with: abcdefgh
recipe_id	int	recipe ID, e.g. 1
thumbnail_size	int	optional parameter, requested thumbnail size in pixels, has to be a multiple of 5, e.g. 645, not 639

Response

Parameter

Type

Description

int

recipe ID

title

string

recipe title

description

string

recipe description

instructions

string

how to cook as rich text HTML

url

recipe location on website

priority

int

can be used for sorting

created

datetime

modified

datetime

ingredients

array

Parameter	Type	Description
quantity	float	how many units
units	string	e.g. kg, tbsp, piece
title	string	ingredient name
notes	string	e.g. peeled, diced
product_id	string	product unique identifier (e.g. stock keeping unit)
group_title	string	should be grouped by this and used as a block title

categories

array

Parameter	Type	Description
id	int	category id (category title can change, but category id will stay the same)
parent	int	parent category ID
priority	int	can be used for sorting
publish	int	is visible to public?
title	string	category title, e.g. Chrismas Recipe
description	string	large description

images

array

URLs

thumbnails

array

URLs

video

string

video URL e.g. http://vimeo.com/32329926

comments

array list

Parameter	Type	Description
content	string	actuall comment
date	datetime	time at creation
author	string	author name

rating

array

Parameter	Type	Description
value	float	rating value
votes_sum	int	sum of ratings
voters_sum	int	sum of voters (number of people voted)

serving_people

int

how many people this recipe can serve with current ingrediants quantity/units

preparation_time

int

preparation time in minutes

cook_time

int

cooking time in minutes

recommended_wines

array

Parameter	Type	Description
id	int	x
title	sting	x
description	string	x
wine_type	string	e.g. Red
grape_variety	string	e.g. Merlot
country	string	Country of origin, e.g. Italy
image_url	string	URL of image location
price_range	string	e.g. €6-€8
product_id	string	product unique identifier (e.g. stock keeping unit)

related_offers

array list

Parameter	Type	Description
id	int	related offer id

Recipe Search

GET /api/v1.4/recipe_search

Search for recipes. We'll return list of recipe IDs. Make Example Call

Request

Parameter	Type	Description
format	string	Available values: json or xml
api_key	string	identify API consumer, testing with: abcdefgh
meal_type_id	int	DEPRECATED, course, e.g. 903 for Desserts
category_id	int	category id, e.g. 2110 for Weekday Dinners
product_id	string	will return recipes with ingredients having product_id
keyword	string	will look into ingredients, recipe title and description
ready_time	int	preparation_time + cook_time in minutes
thumbnail_size	int	optional parameter, requested thumbnail size in pixels, has to be a multiple of 5, e.g. 645, not 639

Response

Parameter

Type

Description

int

recipe ID

title

string

recipe title

description

string

recipe description (excerpt)

images

array

URLs

thumbnails

array

URLs

video

string

video URL e.g. http://vimeo.com/32329926

ready_time

int

preparation_time + cook_time in minutes

categories

array

Parameter	Type	Description
id	int	category id (category title can change, but category id will stay the same)
parent	int	parent category ID
priority	int	can be used for sorting
publish	int	is visible to public?
title	string	category title, e.g. Chrismas Recipe
description	string	large description

url

recipe location on website

Recipe Category List

GET /api/v1.4/recipe_category_list

Returns list of recipe categories. Make Example Call

Request

Parameter	Type	Description
format	string	Available values: json or xml
api_key	string	identify API consumer, testing with: abcdefgh

Response

Parameter	Type	Description
id	int	category id (category title can change, but category id will stay the same)
parent	int	parent category ID
title	string	category name
description	string	category description excerpt
priority	int	can be used for sorting
publish	int	is visible to public?
image_thumbnail	string	category thumbnail URL

Special Offer List

GET /api/v1.4/special_offer_list

Returns list of active and scheduled special offers. Make Example Call

Request

Parameter	Type	Description
format	string	Available values: json or xml
api_key	string	identify API consumer, testing with: abcdefgh
filter_group_id	int	optional parameter, show only offers from this group_id (e.g. filter_group_id=1491 will show "This week offers")
thumbnail_size	int	optional parameter, requested thumbnail size in pixels, has to be a multiple of 5, e.g. 645, not 639

Response

Parameter

Type

Description

int

title

string

offer name

content

string

offer description

url

string

link to offer details on website

priority

int

can be used for sorting

created

datetime

modified

datetime

images

array

list of URLs

thumbnails

array

URLs

rondel

string

e.g. e10, can be empty

rondel_image_url

string

URL of rondel image, can be empty

price

string

e.g. Now "€3.14" or "Details Instore"

start_date

datetime

Exact time when the offer starts to be valid

expiry_date

datetime

Exact time when the offer expires

categories

array

Parameter	Type	Description
id	int	category id (category title can change, but category id will stay the same)
parent	int	parent category ID
priority	int	can be used for sorting
publish	int	is visible to public?
title	string	category title, e.g. Off-License
description	string	large description

product_id

string

product unique identifier (e.g. stock keeping unit)

group_id

int

offers should be grouped by this. Returns NULL if the offer is not groupped.

group_title

string

title for the group

Store Location List

GET /api/v1.4/store_location_list

Returns list of stores address. Make Example Call

Request

Parameter	Type	Description
format	string	Available values: json or xml
api_key	string	identify API consumer, testing with: abcdefgh

Response

Parameter

Type

Description

int

internal store ID

title

string

store name

address

string

street address

city

string

store city

county

string

store county

country

string

country

latitude

float

e.g. 52.3872369

longitude

float

e.g. -9.2994745

opening_hours

string

preformated text

phone

string

contact telephone number

fax

string

contact fax number

manager

string

Mr FirstName LastName

modified

datetime

last update

categories

array

Parameter	Type	Description
id	int	category id (category title can change, but category id will stay the same)
parent	int	parent category ID
priority	int	can be used for sorting
publish	int	is visible to public?
title	string	category title, e.g. Off-License
description	string	large description

Recipe Rating

GET /api/v1.4/recipe_rating

Allow to pass rating to recipe. Make Example Call

Request

Parameter	Type	Description
format	string	Available values: json or xml
api_key	string	identify API consumer, testing with: abcdefgh
recipe_id	int	Valide recipe_id from recipe_list
rating	int	rating value, valid values are: 1, 2, 3, 4 or 5

Response

parameter

type

description

rating_submitted

int

Only on success, otherwise now included.

rating_submitted

array

Only on success, otherwise now included.

parameter	type	description
value	int	new rating value
votes_sum	int	deprecated
voters_sum	int	count of number of entries

message

string

Detail about result

status

int

200 for success, 400 for error