Difference between revisions of "API"
Jump to navigation
Jump to search
m (fixed typo) |
m (added valid alternatives for image field) |
||
| Line 151: | Line 151: | ||
* Photos post on /cgi/product_image_upload.pl | * Photos post on /cgi/product_image_upload.pl | ||
** code: the barcode | ** code: the barcode | ||
| − | ** imagefield: "front" | + | ** imagefield: ("front"|"ingredients"|"nutrition") |
** imgupload_front : your image file | ** imgupload_front : your image file | ||
Revision as of 16:09, 11 January 2016
Status
Currently the API is mainly used internally for Cordova application, but does not follow good practices in API design. It is also used by several application and while not yet stable, doesn't change much. You can ask for help on using the API in this [channel]. You can have a look at the source code of the app (https://github.com/openfoodfacts/cordova-app/blob/master/www/off.js and https://github.com/openfoodfacts/cordova-app/blob/master/www/index.html)
Testing
- You should do all your test edits on http://world.openfoodfacts.net (ask for the password on Slack)
- Do not hesitate to create a global account for your app if you don't want to implement Open Food Facts user creation in your app right now.
READ API Documentation
Countries
You can either use the global (world) for locales (fr, en…)
A few things to note:
- if you use a country subdomain instead of world, you get products for that countries only which might change the language but also the name of the fields, in that case you need to use the local language
- http://fr.openfoodfacts.org/categorie/pizzas.json
- an alternative is to specify the language in the subdomain: http://fr-en.openfoodfacts.org/category/pizzas.json
Reading a product
See http://fr.openfoodfacts.org/data or http://en.openfoodfacts.org/data The requested subdomain will be the locale fetched.
- http://world.openfoodfacts.org/api/v0/product/737628064502.xml
- http://world.openfoodfacts.org/api/v0/product/737628064502.json
Searching for products
Parameters
- sort_by=unique_scans_n
- page_size=50 (20 by default, 1000 at most)
- page=2
- jqm=1 to search results pages on the web site to get results in a jquerymobile format.
Example: (remember to do tests on .net)
http://world.openfoodfacts.org/cgi/search.pl?search_terms=coke&search_simple=1&jqm=1
Combining Tags
Combining tags works, letting you create thousands of APIs
Search results
Labels
List of labels
Individual label
- http://world.openfoodfacts.org/label/utz-certified.json
- http://world.openfoodfacts.org/label/utz-certified.xml
Categories
List of categories
Individual category
- http://world.openfoodfacts.org/category/baby-foods.json
- http://world.openfoodfacts.org/category/baby-foods.xml
Status of products
List of States
Individual Status
- http://world.openfoodfacts.org/state/complete.json
- http://world.openfoodfacts.org/state/complete.xml
Packaging
List of Packagings
Individual Packaging
- http://world.openfoodfacts.org/packaging/cardboard.json
- http://world.openfoodfacts.org/packaging/cardboard.xml
Brands
List of Brands
Individual Brand
- http://world.openfoodfacts.org/brand/monoprix.json
- http://world.openfoodfacts.org/brand/monoprix.xml
Purchase Place of products
List of Purchase Place
- http://world.openfoodfacts.org/purchase-places.json
- http://world.openfoodfacts.org/purchase-places.xml
Individual Purchase Place
- http://world.openfoodfacts.org/purchase-place/marseille-5.json
- http://world.openfoodfacts.org/purchase-place/marseille-5.xml
Store of products
List of Stores
Individual Store
Country of products
List of Countries
Individual Country
- http://world.openfoodfacts.org/country/france.json
- http://world.openfoodfacts.org/country/france.xml
Trace of products
List of Traces
Individual Trace
Additive of products
List of Additives
Individual Additive
- http://world.openfoodfacts.org/additive/e301-sodium-ascorbate.json
- http://world.openfoodfacts.org/additive/e301-sodium-ascorbate.xml
Ingredient of products
List of Ingredients
Individual Ingredient
- http://world.openfoodfacts.org/ingredient/egg.json
- http://world.openfoodfacts.org/ingredient/egg.xml
Barcodes
List of List of barcodes beginning with a given number
List of barcodes beginning with 3596710
- http://world.openfoodfacts.org/code/3596710xxxxxx.json
- http://world.openfoodfacts.org/code/3596710xxxxxx.xml
Entry dates
List of entry dates
List of products with a given entry date
- http://world.openfoodfacts.org/entry-date/2015.json
- http://world.openfoodfacts.org/entry-date/2015.xml
Packager codes
List of Packager codes
- http://world.openfoodfacts.org/packager-codes.json
- http://world.openfoodfacts.org/packager-codes.xml
List of products with given Packager code
- http://world.openfoodfacts.org/packager-code/emb-35069c.json
- http://world.openfoodfacts.org/packager-code/emb-35069c.xml
WRITE API Documentation
Posting photos
- Photos post on /cgi/product_image_upload.pl
- code: the barcode
- imagefield: ("front"|"ingredients"|"nutrition")
- imgupload_front : your image file
Example: (remember to do tests on .net)
http://world.openfoodfacts.org/cgi/product_image_upload.pl
Posting a new product
- Product post to http://world.openfoodfacts.org/cgi/product_jqm2.pl (remember to do tests on .net)
- 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: (remember to do tests on .net)
http://world.openfoodfacts.org/cgi/product_jqm2.pl?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