API
API Redesign
Currently the API is mainly used internally for Cordova application, but does not follow good practices in API design.
And since its the most requested feature on UserVoice, project was launched to evolve the API.
API Basic Documentation
Reading a product
See http://fr.openfoodfacts.org/data or http://en.openfoodfacts.org/data
The requested subdomain will be the locale fetched.
Searching for products
You can add &jqm=1 to search results pages on the web site to get results in a jquerymobile format.
Also:
- sort_by=unique_scans_n
- page_size=50 (20 by default, 1000 at most)
- page=2
e.g. http://world.openfoodfacts.org/cgi/search.pl?search_terms=coke&search_simple=1&jqm=1
Posting photos
- Photos post on /cgi/product_image_upload.pl
code: the barcode imagefield: "front" imgupload_front : your image file
Posting a new product
- Product post to http://fr.openfoodfacts.org/cgi/product_jqm2.pl
var foodfact = { barcode : '3073780969000', name : 'KIRI GOUTER 280G 8 PORTIONS', energy: 500, energy_unit: "kJ", weight: 282 };
var postData = {
code : foodfact.barcode,
user_id : "mesinfosnutritionelles",
password : "****",
product_name : foodfact.name?foodfact.name:foodfact.shop_label,
quantity : foodfact.weight?""+foodfact.weight+" g":undefined,
stores : "Intermarché",
nutriment_energy :foodfact.energy,
nutriment_energy_unit :foodfact.energy_unit,
nutrition_data_per :"serving"
{"status_verbose":"fields saved","status":1}
Example:
code=3073780969000&user_id=usernameexample&password=*****&product_name=KIRI%20GOUTER%20280G%208%20PORTIONS&quantity=282%20g&stores=Intermarch%C3%A9&nutriment_energy=500&nutriment_energy_unit=kJ&nutrition_data_per=serving
TODO
Translate the data page (http://fr.openfoodfacts.org/data) in Englishand make it available on all subdomains- Document all current API
- Write further API specifications