Difference between revisions of "API"

From Open Food Facts wiki
Jump to navigation Jump to search
m
Line 75: Line 75:
 
* In general, ensure the user exercises maintains caution (for allergens…) and be upfront about possible risks.
 
* In general, ensure the user exercises maintains caution (for allergens…) and be upfront about possible risks.
  
−
== READ API Documentation ==
 
−
=== Downloading static data ===
 
−
It is recommended to use the live API to get fresh data about products, the minute they are uploaded to the database. However, in some cases, you may need a snapshot. They are available at:
 
−
* https://world.openfoodfacts.org/data (all data)
 
−
* https://fr.openfoodfacts.org/data (data for that country)
 
  
−
==== CSV API ====
+
== Read API ==
−
The character that separates fields is <tab> (tabulation).
+
[[API/Read]]
−
===== Encoding =====
 
−
The file encoding is Unicode UTF-8.
 
−
==== MongoDB dump ====
 
  
−
=== Field reference ===
+
== Write API ==
−
The [[fields used]] in the api.
 
−
https://world.openfoodfacts.org/data/data-fields.txt
 
  
−
=== JSON interface ===
+
[[API/Write]]
−
=== Pagination of results ===
 
−
If you're looking for all products within a facet (eg: https://fr-en.openfoodfacts.org/category/pizzas.json), you'll only have the 1st page.
 
−
To move from page to page:
 
−
<pre>
 
−
https://fr-en.openfoodfacts.org/category/pizzas/1.json
 
−
https://fr-en.openfoodfacts.org/category/pizzas/2.json
 
−
</pre>
 
−
=== Countries and Language of the Response ===
 
−
You can either use the global (https://world.openfoodfacts.org, https://ssl-api.openfoodfacts.org) or local (https://fr.openfoodfacts.org,https://en.openfoodfacts.org…) domains for your API queries
 
−
 
 
−
====A few things to note====
 
−
* if you use a country subdomain instead of world, you get products for that country only, which might change the language but also the name of the fields. In that case you need to use the local language.
 
−
** https://fr.openfoodfacts.org/categorie/pizzas.json
 
−
* an alternative to avoid dealing with local languages is to specify the language in the subdomain: https://fr-en.openfoodfacts.org/category/pizzas.json
 
−
 
 
−
==== Country code (cc) and Language of the interface (lc) ====
 
−
By default, the country code (cc) and language of the interface (lc) are set through the subdomain.
 
−
===== Examples =====
 
−
# https://world.openfoodfacts.org --> cc = world, lc = en (default language for the "country")
 
−
# https://fr.openfoodfacts.org --> cc = fr (France), lc = fr (French)
 
−
# https://jp.openfoodfacts.org --> cc = jp (Japan), lc = ja (Japanese)
 
−
# https://ch.openfoodfacts.org --> cc = ch (Switzerland), lc = de (German, set as main language for Switzerland)
 
−
# https://ch-fr.openfoodfacts.org --> cc = ch, lc = fr (French)
 
−
==== Over-riding Country code (cc) and Language of the interface (lc) using cc and lc parameters ====
 
−
If you pass ?cc=us and/or &lc=it, it will set the country to US and the language to Italian
 
−
-> if you just pass cc, the lc will be the one set in the subdomain.
 
−
e.g. world.openfoodfacts.org + cc = fr --> cc = fr, lc = en (default language of world)
 
−
 
 
−
The cc affects which results are returned. cc = fr -> you get only products with France listed in the countries where sold field.
 
−
 
 
−
The lc affects the language in which results will come back.
 
−
 
 
−
If the results include links to products, those links will use a new subdomain that corresponds to the overrides.
 
−
 
 
−
=== Reading a product ===
 
−
The requested subdomain will be the locale fetched. (fr.openfoodfacts will fetch FR, world.openfoodfacts EN, world-fr FR products from the whole world)
 
−
 
 
−
==== Structure of the call ====
 
−
 
 
−
* https://world.openfoodfacts.org/api/v0/product/737628064502.xml
 
−
* https://world.openfoodfacts.org/api/v0/product/737628064502.json
 
−
 
 
−
The final number must be a valid barcode.
 
−
 
 
−
==== Status codes ====
 
−
===== If a product is not found =====
 
−
<pre>
 
−
{ 
 
−
  "status_verbose":"product not found",
 
−
  "code":"32421",
 
−
  "status":0
 
−
}
 
−
</pre>
 
−
 
 
−
===== If the product is found properly =====
 
−
 
 
−
See a full example: [[API/Full JSON example]]
 
−
 
 
−
==== Fields within a product ====
 
−
==== Name ====
 
−
* product_name : name of the product : Coca Cola
 
−
* generic_name : name that shouldn't contain brands : Cola soda
 
−
* generic_name_LANG_CODE : name that shouldn't contain brands:
 
−
** generic_name_fr:soda au cola
 
−
** generic_name_en:cola soda
 
−
 
 
−
====Barcodes====
 
−
* code : barcode of the product (can be EAN-13 or internal codes for some food stores), for products without a barcode, Open Food Facts assigns a number starting with the 200 reserved prefix
 
−
=====List of List of barcodes beginning with a given number =====
 
−
* https://world.openfoodfacts.org/codes.json
 
−
* https://world.openfoodfacts.org/codes.xml
 
−
=====List of barcodes beginning with 3596710 =====
 
−
* https://world.openfoodfacts.org/code/3596710xxxxxx.json
 
−
* https://world.openfoodfacts.org/code/3596710xxxxxx.xml
 
−
 
 
−
==== Quantity and unit ====
 
−
* quantity : quantity and unit
 
−
==== URL of the product page ====
 
−
* url : url of the product page on Open Food Facts
 
−
 
 
−
====Brands====
 
−
* brands
 
−
* brands_tags
 
−
=====List of Brands=====
 
−
* https://world.openfoodfacts.org/brands.json
 
−
* https://world.openfoodfacts.org/brands.xml
 
−
=====Individual Brand=====
 
−
* https://world.openfoodfacts.org/brand/monoprix.json
 
−
* https://world.openfoodfacts.org/brand/monoprix.xml
 
−
 
 
−
==== Product images ====
 
−
* Images ensure the reliability of Open Food Facts data. It provides a primary source and proof of all the structured data. You may therefore want to display it along the structured information.
 
−
* We encourage you to let your users upload images for products that don't exist yet, and for existing products as well (packaging and information changes over time).
 
−
* We have different scales of images. Use them wisely to save bandwidth, both for your users and Open Food Facts.
 
−
 
 
−
===== Raw images =====
 
−
* image_small_url
 
−
* image_thumb_url
 
−
* image_url
 
−
===== Front image =====
 
−
* "image_front_url"
 
−
* "image_front_small_url"
 
−
* "image_front_thumb_url"
 
−
===== Ingredients image =====
 
−
* "image_ingredients_url"
 
−
* "image_ingredients_small_url"
 
−
* "image_ingredients_thumb_url"
 
−
===== Nutrition image =====
 
−
* "image_nutrition_url"
 
−
* "image_nutrition_small_url"
 
−
* "image_nutrition_thumb_url"
 
−
 
 
−
==== Languages ====
 
−
Languages on the packaging of the product.
 
−
=====List of languages present on packaging =====
 
−
* https://world.openfoodfacts.org/languages.json
 
−
* https://world.openfoodfacts.org/languages.xml
 
−
=====List of products with given language on packaging =====
 
−
* https://world.openfoodfacts.org/language/italian.json
 
−
* https://world.openfoodfacts.org/language/italian.xml
 
−
=====List of products in Italian and Chinese =====
 
−
* https://world.openfoodfacts.org/language/italian/language/chinese.json
 
−
===== List of multilingual products =====
 
−
* https://world.openfoodfacts.org/language/multilingual.json
 
−
* https://world.openfoodfacts.org/language/multilingual.xml
 
−
===== List of products by language count =====
 
−
* https://world.openfoodfacts.org/language/1.json
 
−
* https://world.openfoodfacts.org/language/1.xml
 
−
* https://world.openfoodfacts.org/language/2.json
 
−
* https://world.openfoodfacts.org/language/2.xml
 
−
* https://world.openfoodfacts.org/language/3.json
 
−
* https://world.openfoodfacts.org/language/3.xml
 
−
=====Getting suggestions for languages=====
 
−
* https://world.openfoodfacts.org/cgi/suggest.pl?lc=fr&tagtype=languages&string=a
 
−
 
 
−
 
 
−
====Labels====
 
−
===== Labels =====
 
−
* labels
 
−
* labels_fr
 
−
===== Label tags =====
 
−
* labels_tags
 
−
* labels_debug_tags
 
−
* labels_prev_tags
 
−
* labels_next_tags
 
−
 
 
−
===== Label hierarchy =====
 
−
* labels_hierarchy
 
−
* labels_prev_hierarchy
 
−
* labels,labels_next_hierarchy
 
−
 
 
−
 
 
−
For a list of all taxonomized values in all supported languages, please refer to the [[Global labels taxonomy]]
 
−
=====List of labels=====
 
−
* https://world.openfoodfacts.org/labels.json
 
−
* https://world.openfoodfacts.org/labels.xml
 
−
=====Individual label=====
 
−
* https://world.openfoodfacts.org/label/utz-certified.json
 
−
* https://world.openfoodfacts.org/label/utz-certified.xml
 
−
 
 
−
===== Label images =====
 
−
No format API is currently available. However, they are predictable:
 
−
<pre>
 
−
https://static.openfoodfacts.org/images/lang/en/labels/eu-organic.135x90.svg
 
−
</pre>
 
−
 
 
−
A full list is available at:
 
−
<pre>
 
−
https://github.com/openfoodfacts/openfoodfacts-server/tree/master/html/images/lang/fr/labels
 
−
https://github.com/openfoodfacts/openfoodfacts-server/tree/master/html/images/lang/en/labels
 
−
https://github.com/openfoodfacts/openfoodfacts-server/tree/master/html/images/lang/de/labels
 
−
</pre>
 
−
 
 
−
=====Getting suggestions for labels=====
 
−
* https://world.openfoodfacts.org/cgi/suggest.pl?lc=fr&tagtype=labels&string=a
 
−
 
 
−
====Categories====
 
−
For a list of all possible values in all supported languages, please refer to the [[Global categories taxonomy]]
 
−
* categories
 
−
* categories_tags
 
−
* categories_fr
 
−
* main_category
 
−
* main_category_fr
 
−
===== Hierarchy =====
 
−
The categories_hierarchy is sorted by the "level" of each category. Level 0 means the category has no children, level 1 means it has children that do not have other children, level 2 is when it has children that have children that do not have children etc.
 
−
 
 
−
=====List of categories=====
 
−
* https://world.openfoodfacts.org/categories.json
 
−
* https://world.openfoodfacts.org/categories.xml
 
−
=====Individual category=====
 
−
* https://world.openfoodfacts.org/category/baby-foods.json
 
−
* https://world.openfoodfacts.org/category/baby-foods.xml
 
−
=====Getting suggestions for categories=====
 
−
* https://world.openfoodfacts.org/cgi/suggest.pl?lc=fr&tagtype=categories&string=a
 
−
 
 
−
==== Location of a product (from country to store) ====
 
−
===== Origins of ingredients =====
 
−
 
 
−
* origins : origins of ingredients
 
−
* origins_tags
 
−
 
 
−
===== Manufacturing Places =====
 
−
* manufacturing_places : places where manufactured or transformed
 
−
* manufacturing_places_tags
 
−
 
 
−
===== Cities =====
 
−
* cities
 
−
* cities_tags
 
−
 
 
−
=====Country of products=====
 
−
* countries : list of countries where the product is sold
 
−
* countries_tags
 
−
* countries_fr
 
−
======List of Countries ======
 
−
* https://world.openfoodfacts.org/countries.json
 
−
* https://world.openfoodfacts.org/countries.xml
 
−
======Individual Country ======
 
−
* https://world.openfoodfacts.org/country/france.json
 
−
* https://world.openfoodfacts.org/country/france.xml
 
−
======Getting suggestions for Countries======
 
−
* https://world.openfoodfacts.org/cgi/suggest.pl?lc=fr&tagtype=countries&string=f
 
−
=====Purchase place of products=====
 
−
* purchase_places
 
−
======List of purchase places ======
 
−
* https://world.openfoodfacts.org/purchase-places.json
 
−
* https://world.openfoodfacts.org/purchase-places.xml
 
−
======Individual purchase place ======
 
−
* https://world.openfoodfacts.org/purchase-place/marseille-5.json
 
−
* https://world.openfoodfacts.org/purchase-place/marseille-5.xml
 
−
=====Store of products=====
 
−
* stores
 
−
======List of Stores======
 
−
* https://world.openfoodfacts.org/stores.json
 
−
* https://world.openfoodfacts.org/stores.xml
 
−
======Individual Store======
 
−
* https://world.openfoodfacts.org/store/super-u.json
 
−
* https://world.openfoodfacts.org/store/super-u.xml
 
−
 
 
−
==== Composition of a product : ingredients, detected ingredients, traces, allergens ====
 
−
 
 
−
===== Ingredients =====
 
−
<pre>Do not make the assumption that the ingredient is or is not present based on this. Parsing errors happen.</pre>
 
−
====== List of ingredients on a specific product ======
 
−
* On a product '''ingredients_text''' contains the text of the ingredients.
 
−
** ingredients_text_fr, ingredients_text_nl… (the package of a product may be multilingual)
 
−
** ingredients_text_with_allergens_fr (same with HTML markup around allergens)
 
−
* This list is parsed and we construct an '''ingredients''' and '''ingredients_tags''' list, but those will contain synonyms etc. We do not have a full taxonomy for ingredients yet. It's a work in progress.
 
−
** ingredients
 
−
*** percent: possible detected percentage (still unreliable)
 
−
*** rank: the order of the ingredient in the ingredient list
 
−
*** id: a slug version of the detected ingredient
 
−
*** text: the raw text of the detected ingredient
 
−
** ingredients_tags
 
−
* The ingredients are not yet taxonomized on [https://world.openfoodfacts.org Open Food Facts]. They are taxonomized on [https://world.openbeautyfacts.org Open Beauty Facts]
 
−
* The taxonomies of ingredients need expansion:  [[Global ingredients taxonomy]] (OFF), [https://en.wiki.openbeautyfacts.org/Global_ingredients_taxonomy Global ingredients taxonomy Open Beauty Facts]
 
−
====== List of detected ingredients ======
 
−
* https://world.openfoodfacts.org/ingredients.json
 
−
* https://world.openfoodfacts.org/ingredients.xml
 
−
====== List of products where a specific ingredient has been detected ======
 
−
* https://world.openfoodfacts.org/ingredient/sucre.xml
 
−
* https://world.openfoodfacts.org/ingredient/sucre.json
 
−
======Getting suggestions for ingredients (ONLY FOR OBF at the moment) ======
 
−
* https://world.openbeautyfacts.org/cgi/suggest.pl?lc=fr&tagtype=ingredients&string=f
 
−
 
 
−
 
 
−
===== Vitamins and minerals detection =====
 
−
 
 
−
 
 
−
====== Vitamins ======
 
−
<pre>"vitamins_tags":["en:vitamin-a","en:cholecalciferol","en:vitamin-e","en:vitamin-c","en:thiamin","en:riboflavin","en:niacin","en:vitamin-b6","en:folic-acid","en:vitamin-b12","en:biotin","en:phylloquinone"]</pre>
 
−
====== Minerals ======
 
−
<pre>"minerals_tags":["en:calcium-citrate","en:potassium-citrate","en:sodium-citrate","en:magnesium-chloride","en:calcium-phosphate","en:potassium-phosphate","en:ferrous-sulphate","en:zinc-sulphate","en:cupric-sulphate","en:manganese-sulphate","en:sodium-carbonate","en:potassium-iodide"]</pre>
 
−
 
 
−
====== Amino acids ======
 
−
<pre>"amino_acids_tags":["en:l-tryptophan"]</pre>
 
−
 
 
−
====== Other nutritional substances =====
 
−
<pre>"other_nutritional_substances_tags":["en:taurine","en:inositol","en:choline-citrate","en:taurine","en:inositol","en:choline-citrate","en:taurine","en:inositol","en:choline-citrate"]<pre>
 
−
 
 
−
===== Palm Oil Detection =====
 
−
* ingredients_from_palm_oil_n
 
−
* ingredients_from_palm_oil
 
−
* ingredients_from_palm_oil_tags
 
−
* ingredients_that_may_be_from_palm_oil_n
 
−
* ingredients_that_may_be_from_palm_oil
 
−
* ingredients_that_may_be_from_palm_oil_tags
 
−
====== Ingredients from palm oil ======
 
−
======= List of ingredients from palm oil =======
 
−
* https://world.openfoodfacts.org/ingredients-from-palm-oil.json
 
−
* https://world.openfoodfacts.org/ingredients-from-palm-oil.xml
 
−
======= List of products where a specific ingredient from palm oil has been detected =======
 
−
* https://world.openfoodfacts.org/ingredients-from-palm-oil/huile-de-palme.json
 
−
* https://world.openfoodfacts.org/ingredients-from-palm-oil/huile-de-palme.xml
 
−
 
 
−
====== Ingredients that may be from palm oil ======
 
−
======= List of ingredients that may be from palm oil =======
 
−
* https://world.openfoodfacts.org/ingredients-that-may-be-from-palm-oil.json
 
−
* https://world.openfoodfacts.org/ingredients-that-may-be-from-palm-oil.xml
 
−
 
 
−
======= List of products where a specific ingredient that may be from palm oil has been detected =======
 
−
* https://world.openfoodfacts.org/ingredients-that-may-be-from-palm-oil/e470b-stearate-de-magnesium.json
 
−
* https://world.openfoodfacts.org/ingredients-that-may-be-from-palm-oil/e470b-stearate-de-magnesium.xml
 
−
 
 
−
=====Trace of products=====
 
−
* traces
 
−
* traces_tags
 
−
======List of Traces ======
 
−
* https://world.openfoodfacts.org/traces.json
 
−
* https://world.openfoodfacts.org/traces.xml
 
−
======Individual Trace ======
 
−
* https://world.openfoodfacts.org/trace/eggs.json
 
−
* https://world.openfoodfacts.org/trace/eggs.xml
 
−
 
 
−
======Getting suggestions for traces ======
 
−
* https://world.openfoodfacts.org/cgi/suggest.pl?lc=fr&tagtype=traces&string=m
 
−
 
 
−
===== Food (or cosmetic) additives =====
 
−
* additives_n : number of food additives
 
−
* additives
 
−
* additives_tags
 
−
For a list of all taxonomized values in all supported languages, please refer to the [[Global additives taxonomy]]
 
−
====== List of Additives ======
 
−
* https://world.openfoodfacts.org/additives.json
 
−
* https://world.openfoodfacts.org/additives.xml
 
−
====== Individual Additive ======
 
−
* https://world.openfoodfacts.org/additive/e301-sodium-ascorbate.json
 
−
* https://world.openfoodfacts.org/additive/e301-sodium-ascorbate.xml
 
−
====== Getting suggestions for additives ======
 
−
* https://world.openfoodfacts.org/cgi/suggest.pl?lc=fr&tagtype=additives&string=e
 
−
 
 
−
=====Allergens of products=====
 
−
======List of allergens======
 
−
* https://world.openfoodfacts.org/allergens.json
 
−
* https://world.openfoodfacts.org/allergens.xml
 
−
======Individual allergen======
 
−
* https://world.openfoodfacts.org/allergen/fish.json
 
−
* https://world.openfoodfacts.org/allergen/fish.xml
 
−
 
 
−
======Getting suggestions for allergens ======
 
−
* https://world.openfoodfacts.org/cgi/suggest.pl?lc=fr&tagtype=allergens&string=a
 
−
 
 
−
==== Nutrition values ====
 
−
===== Nutrition data =====
 
−
====== General structure ======
 
−
The nutrition facts are presented by multiple fields per nutrition fact. Each nutrition fact is presented by a key, i.e. "salt", "fat", etc. The fields can also be found in the taxonomy translation file.
 
−
 
 
−
The fields can have the following structure:
 
−
* key (string) - the value for the nutrition fact key (eg in json: "fiber":"0.5");
 
−
* key_serving (string) -  the value of a serving for type key (eg: in json "carbohydrates_serving":"5.82"). The size of the servig is found in the serving field;
 
−
* key_value (string)  - the standardized value of a serving of 100g (100ml) for type key (eg in json: "salt_100g":"0.19");
 
−
* key_100g (string) - the standardized value of a serving of 100g (100ml) for type key (eg in json: "salt_100g":"0.19");
 
−
* key_unit (string) - the units used in the other fields (eg in json: "carbohydrates_unit":"g"). Possible values are "kg", "g", "mg, "µg", "l", "ml", "%" or "";
 
−
* key_label (string) - a more user friendly text explaining the
 
−
 
 
−
Only the nutrition facts that are actually found on the packaging are present in the interface.
 
−
 
 
−
====== List of nutrition keys ======
 
−
The following nutrition keys are supported:
 
−
* energy
 
−
* proteins
 
−
* casein
 
−
* serum-proteins
 
−
* nucleotides
 
−
* carbohydrates
 
−
* sugars
 
−
* sucrose
 
−
* glucose
 
−
* fructose
 
−
* lactose
 
−
* maltose
 
−
* maltodextrins
 
−
* starch
 
−
* polyols
 
−
* fat
 
−
* saturated-fat
 
−
* butyric-acid
 
−
* caproic-acid
 
−
* caprylic-acid
 
−
* capric-acid
 
−
* lauric-acid
 
−
* myristic-acid
 
−
* palmitic-acid
 
−
* stearic-acid
 
−
* arachidic-acid
 
−
* behenic-acid
 
−
* lignoceric-acid
 
−
* cerotic-acid
 
−
* montanic-acid
 
−
* melissic-acid
 
−
* monounsaturated-fat
 
−
* polyunsaturated-fat
 
−
* omega-3-fat
 
−
* alpha-linolenic-acid
 
−
* eicosapentaenoic-acid
 
−
* docosahexaenoic-acid
 
−
* omega-6-fat
 
−
* linoleic-acid
 
−
* arachidonic-acid
 
−
* gamma-linolenic-acid
 
−
* dihomo-gamma-linolenic-acid
 
−
* omega-9-fat
 
−
* oleic-acid
 
−
* elaidic-acid
 
−
* gondoic-acid
 
−
* mead-acid
 
−
* erucic-acid
 
−
* nervonic-acid
 
−
* trans-fat
 
−
* cholesterol
 
−
* fiber
 
−
* sodium
 
−
* alcohol: % vol of alcohol
 
−
* vitamin-a
 
−
* vitamin-d
 
−
* vitamin-e
 
−
* vitamin-k
 
−
* vitamin-c
 
−
* vitamin-b1
 
−
* vitamin-b2
 
−
* vitamin-pp
 
−
* vitamin-b6
 
−
* vitamin-b9
 
−
* vitamin-b12
 
−
* biotin
 
−
* pantothenic-acid
 
−
* silica
 
−
* bicarbonate
 
−
* potassium
 
−
* chloride
 
−
* calcium
 
−
* phosphorus
 
−
* iron
 
−
* magnesium
 
−
* zinc
 
−
* copper
 
−
* manganese
 
−
* fluoride
 
−
* selenium
 
−
* chromium
 
−
* molybdenum
 
−
* iodine
 
−
* caffeine
 
−
* taurine
 
−
 
 
−
====== Specific nutrition keys ======
 
−
* carbon-footprint_100g : carbon footprint (indicated on some products)
 
−
* ph_100g : pH (no unit)
 
−
* cocoa - minimal cacao content of the product in %. Note the TYPO.
 
−
* fruits-vegetables-nuts_100g : % of fruits, vegetables and nuts (excluding potatoes, yams, manioc)
 
−
* fruits_vegetables_nuts_estimate_100g : estimate by manually looking at the list of ingredients
 
−
 
 
−
 
 
−
* nutrition-score-fr_100g : experimental nutrition score derived from the UK FSA score and adapted for the French market (formula defined by the team of Professor Hercberg)
 
−
* nutrition-score-uk_100g : nutrition score defined by the UK Food Standards Administration (FSA)
 
−
 
 
−
===== Nutrition grades (Nutriscore, UK grades) =====
 
−
* For more details, see [https://fr.openfoodfacts.org/score-nutritionnel-experimental-france the page explaining the grade computation]
 
−
* nutrition_score_debug: lets you see the calculations made
 
−
<pre>"nutrition_score_debug":" -- energy 3 + sat-fat 6 + fr-sat-fat-for-fats 6 + sugars 0 + sodium 6 - fruits 0% 0 - fiber 0 - proteins 5 -- fsa 15 -- fr 15"</pre>
 
−
* Nutrition Grade Value
 
−
<pre>
 
−
"nutrition_grades":"d"
 
−
"nutrition_grades_tags":["d"]
 
−
"nutrition_grade_fr":"d"
 
−
</pre>
 
−
====== Nutrition Grade Images ======
 
−
No formal API is available, but you can use:
 
−
<pre>
 
−
https://static.openfoodfacts.org/images/misc/nutriscore-a.svg
 
−
https://static.openfoodfacts.org/images/misc/nutriscore-b.svg
 
−
https://static.openfoodfacts.org/images/misc/nutriscore-c.svg
 
−
https://static.openfoodfacts.org/images/misc/nutriscore-d.svg
 
−
https://static.openfoodfacts.org/images/misc/nutriscore-e.svg
 
−
</pre>
 
−
====== List of all nutrition grades ======
 
−
* https://world.openfoodfacts.org/nutrition-grades.json
 
−
* https://world.openfoodfacts.org/nutrition-grades.xml
 
−
 
 
−
====== List of products with a given nutrition grade (from A to E, including unknown) ======
 
−
* https://world.openfoodfacts.org/nutrition-grade/a.json
 
−
* https://world.openfoodfacts.org/nutrition-grade/a.xml
 
−
* https://world.openfoodfacts.org/nutrition-grade/e.json
 
−
* https://world.openfoodfacts.org/nutrition-grade/e.xml
 
−
* https://world.openfoodfacts.org/nutrition-grade/unknown.json
 
−
* https://world.openfoodfacts.org/nutrition-grade/unknown.xml
 
−
 
 
−
===== Nutrients levels =====
 
−
====== List of all nutrition levels ======
 
−
 
 
−
* https://world.openfoodfacts.org/nutrient-levels.json
 
−
* https://world.openfoodfacts.org/nutrient-levels.xml
 
−
 
 
−
====== List of products with fat in low quantity ======
 
−
* https://world.openfoodfacts.org/nutrient-level/fat-in-low-quantity.json
 
−
* https://world.openfoodfacts.org/nutrient-level/fat-in-low-quantity.xml
 
−
 
 
−
===== Unknown Nutrients =====
 
−
They might be unknown for a good reason…
 
−
======List of Unknown Nutrients ======
 
−
*https://world.openfoodfacts.org/unknown-nutrients.json
 
−
* https://world.openfoodfacts.org/unknown-nutrients.xml
 
−
======Individual Unknown Nutrients======
 
−
* https://world.openfoodfacts.org/unknown-nutrient/sulfates.json
 
−
* https://world.openfoodfacts.org/unknown-nutrient/sulfates.xml
 
−
 
 
−
====Packaging====
 
−
* packaging : shape, material
 
−
* packaging_tags
 
−
* Packaging are not taxonomized yet.
 
−
=====List of Packagings=====
 
−
* https://world.openfoodfacts.org/packaging.json
 
−
* https://world.openfoodfacts.org/packaging.xml
 
−
=====Individual Packaging=====
 
−
* https://world.openfoodfacts.org/packaging/cardboard.json
 
−
* https://world.openfoodfacts.org/packaging/cardboard.xml
 
−
 
 
−
===== Packaging images =====
 
−
No API is currently available. As a workaround, you can use the images from the server, or those folders.
 
−
<pre>
 
−
https://github.com/openfoodfacts/openfoodfacts-server/tree/master/html/images/lang/jp/packaging
 
−
https://github.com/openfoodfacts/openfoodfacts-server/tree/master/html/images/lang/de/packaging
 
−
</pre>
 
−
 
 
−
=====Packager codes=====
 
−
* emb_codes
 
−
* emb_codes_tags
 
−
* first_packaging_code_geo : coordinates corresponding to the first packaging code indicated
 
−
======List of Packager codes ======
 
−
* https://world.openfoodfacts.org/packager-codes.json
 
−
* https://world.openfoodfacts.org/packager-codes.xml
 
−
======List of products with given Packager code ======
 
−
====== EMB (France specific) ======
 
−
* https://world.openfoodfacts.org/packager-code/emb-35069c.json
 
−
* https://world.openfoodfacts.org/packager-code/emb-35069c.xml
 
−
 
 
−
=======EU Codes (Europe-wide) =======
 
−
* https://world.openfoodfacts.org/packager-code/fr-38-012-001-ec.json
 
−
* https://world.openfoodfacts.org/packager-code/fr-38-012-001-ec.xml
 
−
======= Note =======
 
−
Other codes might be present, but we don't have specific support yet
 
−
======List of Packaging cities ======
 
−
* https://world.openfoodfacts.org/cities.json
 
−
* https://world.openfoodfacts.org/cities.xml
 
−
======List of products with given Packaging city ======
 
−
* https://world.openfoodfacts.org/city/argenteuil-val-d-oise-france.json
 
−
* https://world.openfoodfacts.org/city/argenteuil-val-d-oise-france.xml
 
−
 
 
−
 
 
−
==== Contributors ====
 
−
===== Contributors =====
 
−
* https://world.openfoodfacts.org/contributor/teolemon.json
 
−
* https://world.openfoodfacts.org/contributors.json
 
−
===== Photographers =====
 
−
* https://world.openfoodfacts.org/photographer/teolemon.json
 
−
* https://world.openfoodfacts.org/photographers.json
 
−
===== Informers =====
 
−
* https://world.openfoodfacts.org/informer/teolemon.json
 
−
* https://world.openfoodfacts.org/informers.json
 
−
 
 
−
==== Product status & modification history ====
 
−
* creator : contributor who first added the product
 
−
* created_t : date that the product was added (UNIX timestamp format)
 
−
* created_datetime : date that the product was added (iso8601 format: yyyy-mm-ddThh:mn:ssZ)
 
−
* last_modified_t : date that the product page was last modified
 
−
* last_modified_datetime
 
−
 
 
−
=====Status of products=====
 
−
For all possible values, please refer to the [[Global states taxonomy]]
 
−
======List of States ======
 
−
* https://world.openfoodfacts.org/states.json
 
−
* https://world.openfoodfacts.org/states.xml
 
−
======Individual Status ======
 
−
* https://world.openfoodfacts.org/state/complete.json
 
−
* https://world.openfoodfacts.org/state/complete.xml
 
−
======Getting suggestions for states======
 
−
* https://world.openfoodfacts.org/cgi/suggest.pl?lc=fr&tagtype=states&string=a
 
−
===== Last Edit Dates =====
 
−
====== List of Last Edit Dates ======
 
−
* https://world.openfoodfacts.org/last-edit-dates.json
 
−
* https://world.openfoodfacts.org/last-edit-dates.xml
 
−
====== List of products with a given last edit date ======
 
−
* https://world.openfoodfacts.org/last-edit-date/2014.json
 
−
* https://world.openfoodfacts.org/last-edit-date/2016-08.json
 
−
* https://world.openfoodfacts.org/last-edit-date/2016-05-19.json
 
−
* https://world.openfoodfacts.org/last-edit-date/2014.xml
 
−
* https://world.openfoodfacts.org/last-edit-date/2016-08.xml
 
−
* https://world.openfoodfacts.org/last-edit-date/2016-05-19.xml
 
−
===== Entry dates=====
 
−
====== List of entry dates ======
 
−
* https://world.openfoodfacts.org/entry-dates.json
 
−
* https://world.openfoodfacts.org/entry-dates.xml
 
−
====== List of products with a given entry date ======
 
−
* https://world.openfoodfacts.org/entry-dates/2014.xml
 
−
* https://world.openfoodfacts.org/entry-dates/2016-08.xml
 
−
* https://world.openfoodfacts.org/entry-dates/2016-05-19.xml
 
−
* https://world.openfoodfacts.org/entry-dates/2014.json
 
−
* https://world.openfoodfacts.org/entry-dates/2016-08.json
 
−
* https://world.openfoodfacts.org/entry-dates/2016-05-19.json
 
−
 
 
−
=== Searching for products ===
 
−
===== Generic Search =====
 
−
====== Core principle: Combine tags to get custom results ======
 
−
'''Combining tags is really powerful, letting you create thousands of custom APIs for your use case.'''
 
−
* https://world.openfoodfacts.org/packager-code/emb-35069c/brand/sojasun.json
 
−
 
 
−
 
 
−
===== Advanced Search =====
 
−
====== Query examples ======
 
−
<pre>https://world.openfoodfacts.org/cgi/search.pl?search_terms=coke&search_simple=1&jqm=1</pre>
 
−
<pre>https://world.openfoodfacts.org/cgi/search.pl?search_terms=banania&search_simple=1&action=process&json=1</pre>
 
−
<pre>https://world.openfoodfacts.org/cgi/search.pl?search_terms=banania&search_simple=1&action=process&xml=1</pre>
 
−
<pre>https://world.openfoodfacts.org/cgi/search.pl?search_terms=banania&search_simple=1&action=process&rss=1</pre>
 
−
 
 
−
====== Parameters ======
 
−
You can basically use all the parameters you'd use in a [https://world.openfoodfacts.org/cgi/search.pl?action=display&sort_by=unique_scans_n&page_size=20&action=display graphical advanced search on the site]<br>
 
−
 
 
−
<pre>
 
−
search_url = "https://world.openfoodfacts.org/cgi/search.pl"
 
−
search_terms2 # search terms
 
−
 
 
−
# FIRST CRITERIA (TAG0)
 
−
 
 
−
tagtype_0
 
−
search_tag # choose a criterion...
 
−
 
 
−
# CRITERION
 
−
brands # brands
 
−
categories # categories
 
−
packaging # packaging
 
−
labels # labels
 
−
origins # origins of ingredients
 
−
manufacturing_places # manufacturing or processing places
 
−
emb_codes # packager codes
 
−
purchase_places # purchase places
 
−
stores # stores
 
−
countries # countries
 
−
additives # additives
 
−
allergens # allergens
 
−
traces # traces
 
−
nutrition_grades # Nutrition grades
 
−
states # states
 
−
 
−
# Contains or Not
 
−
tag_contains_0
 
−
contains
 
−
does_not_contain
 
−
 
 
−
# Value of Tag (free text)
 
−
tag_0
 
−
 
 
−
#additives
 
−
additives
 
−
without # without_additives
 
−
with # with_additives
 
−
indifferent # indifferent_additives
 
−
 
 
−
# Ingredients from palm oil
 
−
ingredients_from_palm_oil
 
−
without
 
−
with
 
−
indifferent
 
−
 
 
−
# Ingredients that may be from palm oil
 
−
ingredients_that_may_be_from_palm_oil
 
−
without
 
−
with
 
−
indifferent
 
−
 
 
−
#ingredients_from_or_that_may_be_from_palm_oi
 
−
ingredients_from_or_that_may_be_from_palm_oil
 
−
without
 
−
with
 
−
indifferent
 
−
 
 
−
 
 
−
# Nutrients
 
−
 
 
−
nutriment_0
 
−
 
 
−
search_nutriment # choose a nutriment...
 
−
 
 
−
energy # Energy
 
−
energy-from-fat # Energy from fat
 
−
fat # Fat
 
−
saturated-fat # Saturated fat
 
−
butyric-acid # Butyric acid (4:0)
 
−
caproic-acid # Caproic acid (6:0)
 
−
caprylic-acid # Caprylic acid (8:0)
 
−
capric-acid # Capric acid (10:0)
 
−
lauric-acid # Lauric acid (12:0)
 
−
myristic-acid # Myristic acid (14:0)
 
−
palmitic-acid # Palmitic acid (16:0)
 
−
stearic-acid # Stearic acid (18:0)
 
−
arachidic-acid # Arachidic acid (20:0)
 
−
behenic-acid # Behenic acid (22:0)
 
−
lignoceric-acid # Lignoceric acid (24:0)
 
−
cerotic-acid # Cerotic acid (26:0)
 
−
montanic-acid # Montanic acid (28:0)
 
−
melissic-acid # Melissic acid (30:0)
 
−
monounsaturated-fat # Monounsaturated fat
 
−
polyunsaturated-fat # Polyunsaturated fat
 
−
omega-3-fat # Omega 3 fatty acids
 
−
alpha-linolenic-acid # Alpha-linolenic acid / ALA (18:3 n-3)
 
−
eicosapentaenoic-acid # Eicosapentaenoic acid / EPA (20:5 n-3)
 
−
docosahexaenoic-acid # Docosahexaenoic acid / DHA (22:6 n-3)
 
−
omega-6-fat # Omega 6 fatty acids
 
−
linoleic-acid # Linoleic acid / LA (18:2 n-6)
 
−
arachidonic-acid # Arachidonic acid / AA / ARA (20:4 n-6)
 
−
gamma-linolenic-acid # Gamma-linolenic acid / GLA (18:3 n-6)
 
−
dihomo-gamma-linolenic-acid # Dihomo-gamma-linolenic acid / DGLA (20:3 n-6)
 
−
omega-9-fat # Omega 9 fatty acids
 
−
oleic-acid # Oleic acid (18:1 n-9)
 
−
elaidic-acid # Elaidic acid (18:1 n-9)
 
−
gondoic-acid # Gondoic acid (20:1 n-9)
 
−
mead-acid # Mead acid (20:3 n-9)
 
−
erucic-acid # Erucic acid (22:1 n-9)
 
−
nervonic-acid # Nervonic acid (24:1 n-9)
 
−
trans-fat # Trans fat
 
−
cholesterol # Cholesterol
 
−
carbohydrates # Carbohydrate
 
−
sugars # Sugars
 
−
sucrose # Sucrose
 
−
glucose # Glucose
 
−
fructose # Fructose
 
−
lactose # Lactose
 
−
maltose # Maltose
 
−
maltodextrins # Maltodextrins
 
−
starch # Starch
 
−
polyols # Sugar alcohols (Polyols)
 
−
fiber # Dietary fiber
 
−
proteins # Proteins
 
−
casein # casein
 
−
serum-proteins # Serum proteins
 
−
nucleotides # Nucleotides
 
−
salt # Salt
 
−
sodium # Sodium
 
−
alcohol # Alcohol
 
−
vitamin-a # Vitamin A
 
−
beta-carotene # Beta carotene
 
−
vitamin-d # Vitamin D
 
−
vitamin-e # Vitamin E
 
−
vitamin-k # Vitamin K
 
−
vitamin-c # Vitamin C (ascorbic acid)
 
−
vitamin-b1 # Vitamin B1 (Thiamin)
 
−
vitamin-b2 # Vitamin B2 (Riboflavin)
 
−
vitamin-pp # Vitamin B3 / Vitamin PP (Niacin)
 
−
vitamin-b6 # Vitamin B6 (Pyridoxin)
 
−
vitamin-b9 # Vitamin B9 (Folic acid / Folates)
 
−
vitamin-b12 # Vitamin B12 (cobalamin)
 
−
biotin # Biotin
 
−
pantothenic-acid # Pantothenic acid / Pantothenate (Vitamin B5)
 
−
silica # Silica
 
−
bicarbonate # Bicarbonate
 
−
potassium # Potassium
 
−
chloride # Chloride
 
−
calcium # Calcium
 
−
phosphorus # Phosphorus
 
−
iron # Iron
 
−
magnesium # Magnesium
 
−
zinc # Zinc
 
−
copper # Copper
 
−
manganese # Manganese
 
−
fluoride # Fluoride
 
−
selenium # Selenium
 
−
chromium # Chromium
 
−
molybdenum # Molybdenum
 
−
iodine # Iodine
 
−
caffeine # Caffeine
 
−
taurine # Taurine
 
−
ph # pH
 
−
fruits-vegetables-nuts # Fruits, vegetables and nuts (minimum)
 
−
collagen-meat-protein-ratio # Collagen/Meat protein ratio (maximum)
 
−
cocoa # Cocoa (minimum)
 
−
chlorophyl # Chlorophyl
 
−
carbon-footprint # Carbon footprint / CO2 emissions
 
−
nutrition-score-fr # Experimental nutrition score
 
−
nutrition-score-uk # Nutrition score - UK
 
−
 
 
−
# Comparison of nutrients
 
−
# Nutriment to compare
 
−
nutriment_compare_0
 
−
 
 
−
# Operator
 
−
lt # less than
 
−
lte # less than or equal
 
−
gt # greater than
 
−
gte # greater than or equal
 
−
eq # equal to
 
−
 
−
# Value to compare the nutrients to
 
−
nutriment_value_0
 
−
 
 
−
# Output
 
−
sort_by # sort_by
 
−
unique_scans_n # Popularity
 
−
product_name # Product name
 
−
created_t # Add date
 
−
last_modified_t # Edit date
 
−
 
 
−
 
 
−
# Results per page
 
−
page_size # page_size
 
−
20 # 20
 
−
50 # 50
 
−
100 # 100
 
−
250 # 250
 
−
500 # 500
 
−
1000 # 1000
 
−
 
 
−
#Pagination
 
−
page=1
 
−
 
 
−
#Format
 
−
json=1
 
−
xml=1
 
−
#to search results pages on the web site to get results in a jQuery Mobile format.
 
−
jqm=1
 
−
</pre>
 
−
 
 
−
=== Linked Data (coming soon) ===
 
−
==== Link to Wikipedia and Wikidata ====
 
−
Whenever possible, Open Food Facts entities are linked to Wikidata, and in turn to Wikipedia. What this means is that you get access to a trove of additional encyclopedic knowledge about food. You can for instance get: Wikipedia articles about Camembert, the translation of salt in many languages, the molecular structure of a cosmetic ingredient…<br>
 
−
We provide the Wikidata QID, which is an unambiguous, stable and reliable identifier for a concept that will be useful to actually retrieve info from Wikipedia and Wikidata.
 
−
===== Example =====
 
−
 
 
−
https://world.openfoodfacts.net/categories.json
 
−
<pre>
 
−
{"linkeddata":{"wikidata:en":"Q40050"},"url":"https://world.openfoodfacts.net/category/beverages","name":"Beverages","id":"en:beverages","products":14196}
 
−
</pre>
 
−
 
 
−
Beverages >> https://world.openfoodfacts.org/category/beverages >> Q40050 >> https://www.wikidata.org/wiki/Q40050<br>
 
−
As you see, you'll get a beautiful image, information about the Quality label… As Wikidata is a Wiki, the knowledge you'll be able to retrieve will increase over time.
 
−
 
 
−
==== Retrieving info from Wikipedia and Wikidata ====
 
−
You can use the Wikipedia and Wikidata APIs to get the information you want<br>
 
−
* https://www.wikidata.org/wiki/Wikidata:Data_access
 
−
* https://en.wikipedia.org/w/api.php
 
−
 
 
−
==== Examples of things you can do ====
 
−
* Provide more context and more information about a specific Product, a Category of products, a Quality label, a Geography, a Brand, a Packaging material, an ingredient…
 
−
* Perform checks or computations by mixing Wikidata information and Open Food Facts information (and possibly other APIs)
 
−
 
 
−
== WRITE API Documentation ==
 
−
=== Status Codes ===
 
−
==== If the edit was successful ====
 
−
<pre>
 
−
{"status_verbose":"fields saved","status":1}
 
−
</pre>
 
−
==== If there was an issue ====
 
−
===== Wrong password =====
 
−
HTML 200 code + an HTML page with a link to login
 
−
 
−
Example: https://world.openfoodfacts.org/cgi/product_jqm2.pl?code=0048151623426&user_id=usernameexample&password=*****&product_name=KIRI%2
 
−
 
 
−
=== Authentification ===
 
−
* user_id
 
−
* password
 
−
 
 
−
WARNING: If the password is not correct, the API will currently "silently" fail, both for image addition and product data addition (will return HTML 200 code + an html page with a link to login - [https://world.openfoodfacts.org/cgi/product_jqm2.pl?code=0048151623426&user_id=usernameexample&password=*****&product_name=KIRI%2 example] )
 
−
 
 
−
==== Anonymous contribution ====
 
−
 
 
−
* It is possible for new products (no anonymous modification is possible though, for obvious reasons)
 
−
* It is possible for adding images (as many as you like)
 
−
* If you detect an error 200 (wrong password), please retry the query without user_id and password. That way the contribution will be accepted. Otherwise, the photo will get lost :(
 
−
 
 
−
==== Global account ====
 
−
If you want to avoid coding the detection of password errors, login stuff… you can create a global account for all your users.
 
−
 
 
−
You can create a global account to let the users of your app contribute. please name it YourApp_app or something like that, so that we can spot them easily. Better yet, introduce yourself on Slack :-)
 
−
 
 
−
=== Manipulating photos for a product ===
 
−
==== Understanding products and photos ====
 
−
* Photos are the primary source of Open Food Facts.
 
−
* We need good photos of the '''product''', of its '''ingredients''' and '''nutrition table'''. (and for each language present on the packaging)
 
−
* Please encourage your users to add as many photos as possible, even if the product is already complete (in that case, don't set them as default photos for  front, ingredients, and nutrition)
 
−
 
 
−
==== Upload behaviour ====
 
−
If you upload an image (eg for front), the first one will be shown, the others will be saved but not displayed. Useful if you want to let your users take additional images that are neither front, ingredients or nutrition (eg: recycling instructions, labels…)
 
−
 
 
−
==== Understanding photos for multilingual products ====
 
−
Multilingual products have several photos based on languages present on the packaging. Just suffix the lang code to our examples to get or add the relevant language(s).
 
−
 
 
−
==== Adding photos for a product ====
 
−
 
 
−
* Use the POST method on:
 
−
<pre>Test server: https://world.openfoodfacts.net/cgi/product_image_upload.pl</pre>
 
−
<pre>Live server: https://world.openfoodfacts.org/cgi/product_image_upload.pl</pre>
 
−
<sup>(remember to do tests on world.openfoodfacts.net - login and password: off )</sup>
 
−
 
 
−
===== Parameters =====
 
−
* code: the barcode
 
−
* imagefield: (front | ingredients | nutrition)
 
−
* imgupload_front : your image file if imagefield:front
 
−
* imgupload_ingredients: your image file if imagefield:ingredients
 
−
* imgupload_nutrition: your image file if imagefield:nutrition
 
−
 
 
−
 
 
−
===== Example =====
 
−
<pre>
 
−
curl --user off:off --form "imgupload_front=@Tacitus.jpg" --form code=1212121212 --form imagefield=front --form user_id=tacite  --form password=mypassword https://fr.openfoodfacts.net/cgi/product_image_upload.pl</pre>
 
−
 
 
−
=====Important=====
 
−
*  Content-Disposition: form-data; name=“imgupload_front”; filename=“front.png”
 
−
* There must be a HTTP header "Content-Type: multipart/form-data" in the HTTP POST request.
 
−
* The imageupload_(front|ingredients|nutrition) name, size and data needs to be encoded in the multipart/form-data format, usually your HTTP request library will do that for you.
 
−
* All parameters need to be passed as POST parameters, do not put some in the URL.
 
−
* 0048151623426 is a random barcode used only for demonstration purposes.
 
−
 
 
−
==== Getting a list of all available photos ====
 
−
You get a list of all available photos in the product JSON (both selected photos for all languages, and Raw photos (source images for the selected images and images that are not used)
 
−
 
 
−
===== Properties of a photo =====
 
−
* id = 5
 
−
* uploaded_t = 1474912158 (UNIX timestamp format)
 
−
* uploader = tacinte (contributor slug)
 
−
* sizes
 
−
100
 
−
"h":100,
 
−
"w":75
 
−
* 400
 
−
"h":400,
 
−
"w":300
 
−
* full
 
−
"w":3120,
 
−
"h":4160
 
−
 
 
−
===== Properties of a selected photo =====
 
−
* nutrition_fr
 
−
* y1 = 151.8125
 
−
* normalize":"true",
 
−
* x2":"169.75",
 
−
* rev":"13",
 
−
* geometry":"1238x1238-527-1578"
 
−
* sizes
 
−
*100
 
−
"h":100,
 
−
"w":75
 
−
* 200
 
−
* 400
 
−
"h":400,
 
−
"w":300
 
−
* full
 
−
"w":3120,
 
−
"h":4160
 
−
* y2 = 270.8125
 
−
*  x1 = 50.75
 
−
*  angle = 0
 
−
* white_magic = false
 
−
*  imgid = 4
 
−
 
 
−
<pre>
 
−
      "images":{ 
 
−
        "front_fr":{ 
 
−
            "y2":"340.8125",
 
−
            "x1":"67.75",
 
−
            "angle":"0",
 
−
            "imgid":"5",
 
−
            "white_magic":"false",
 
−
            "x2":"245.75",
 
−
            "normalize":"true",
 
−
            "y1":"13.8125",
 
−
            "rev":"10",
 
−
            "geometry":"1851x3401-704-143",
 
−
            "sizes":{ 
 
−
              "400":{ 
 
−
                  "w":218,
 
−
                  "h":400
 
−
              },
 
−
              "full":{ 
 
−
                  "h":3401,
 
−
                  "w":1851
 
−
              },
 
−
              "100":{ 
 
−
                  "w":54,
 
−
                  "h":100
 
−
              },
 
−
              "200":{ 
 
−
                  "h":200,
 
−
                  "w":109
 
−
              }
 
−
            }
 
−
        },
 
−
        "2":{ 
 
−
            "sizes":{ 
 
−
              "400":{ 
 
−
                  "h":400,
 
−
                  "w":300
 
−
              },
 
−
              "full":{ 
 
−
                  "h":4160,
 
−
                  "w":3120
 
−
              },
 
−
              "100":{ 
 
−
                  "w":75,
 
−
                  "h":100
 
−
              }
 
−
            },
 
−
            "uploaded_t":"1474912149",
 
−
            "uploader":"tacinte"
 
−
        },
 
−
        "5":{ 
 
−
            "uploaded_t":"1474912158",
 
−
            "uploader":"tacinte",
 
−
            "sizes":{ 
 
−
              "100":{ 
 
−
                  "h":100,
 
−
                  "w":75
 
−
              },
 
−
              "400":{ 
 
−
                  "h":400,
 
−
                  "w":300
 
−
              },
 
−
              "full":{ 
 
−
                  "w":3120,
 
−
                  "h":4160
 
−
              }
 
−
            }
 
−
        },
 
−
        "3":{ 
 
−
            "uploaded_t":"1474912152",
 
−
            "uploader":"tacinte",
 
−
            "sizes":{ 
 
−
              "full":{ 
 
−
                  "w":3120,
 
−
                  "h":4160
 
−
              },
 
−
              "400":{ 
 
−
                  "h":400,
 
−
                  "w":300
 
−
              },
 
−
              "100":{ 
 
−
                  "h":100,
 
−
                  "w":75
 
−
              }
 
−
            }
 
−
        },
 
−
        "nutrition_fr":{ 
 
−
            "y1":"151.8125",
 
−
            "normalize":"true",
 
−
            "x2":"169.75",
 
−
            "rev":"13",
 
−
            "geometry":"1238x1238-527-1578",
 
−
            "sizes":{ 
 
−
              "full":{ 
 
−
                  "w":1238,
 
−
                  "h":1238
 
−
              },
 
−
              "400":{ 
 
−
                  "h":400,
 
−
                  "w":400
 
−
              },
 
−
              "100":{ 
 
−
                  "w":100,
 
−
                  "h":100
 
−
              },
 
−
              "200":{ 
 
−
                  "w":200,
 
−
                  "h":200
 
−
              }
 
−
            },
 
−
            "y2":"270.8125",
 
−
            "x1":"50.75",
 
−
            "angle":"0",
 
−
            "white_magic":"false",
 
−
            "imgid":"4"
 
−
        },
 
−
        "4":{ 
 
−
            "sizes":{ 
 
−
              "400":{ 
 
−
                  "w":300,
 
−
                  "h":400
 
−
              },
 
−
              "full":{ 
 
−
                  "h":4160,
 
−
                  "w":3120
 
−
              },
 
−
              "100":{ 
 
−
                  "h":100,
 
−
                  "w":75
 
−
              }
 
−
            },
 
−
            "uploader":"tacinte",
 
−
            "uploaded_t":"1474912154"
 
−
        },
 
−
        "ingredients_fr":{ 
 
−
            "y2":"248.8125",
 
−
            "x1":"82.75",
 
−
            "angle":"0",
 
−
            "white_magic":"false",
 
−
            "imgid":"3",
 
−
            "normalize":"true",
 
−
            "y1":"158.8125",
 
−
            "x2":"257.75",
 
−
            "rev":"12",
 
−
            "sizes":{ 
 
−
              "full":{ 
 
−
                  "w":1820,
 
−
                  "h":936
 
−
              },
 
−
              "400":{ 
 
−
                  "h":206,
 
−
                  "w":400
 
−
              },
 
−
              "100":{ 
 
−
                  "h":51,
 
−
                  "w":100
 
−
              },
 
−
              "200":{ 
 
−
                  "h":103,
 
−
                  "w":200
 
−
              }
 
−
            },
 
−
            "geometry":"1820x936-860-1651"
 
−
        },
 
−
        "1":{ 
 
−
            "sizes":{ 
 
−
              "full":{ 
 
−
                  "w":3120,
 
−
                  "h":4160
 
−
              },
 
−
              "400":{ 
 
−
                  "h":400,
 
−
                  "w":300
 
−
              },
 
−
              "100":{ 
 
−
                  "w":75,
 
−
                  "h":100
 
−
              }
 
−
            },
 
−
            "uploaded_t":"1474912148",
 
−
            "uploader":"tacinte"
 
−
        }
 
−
      },
 
−
</pre>
 
−
 
 
−
==== Adding a photo to the list of all available photos ====
 
−
==== Getting the current global photo ====
 
−
==== Setting a new current global photo ====
 
−
==== Getting the current ingredients photo ====
 
−
==== Setting a new current ingredients photo ====
 
−
==== Getting the current nutrition photo ====
 
−
==== Setting a new current nutrition photo ====
 
−
 
 
−
==== Choosing the product by barcode ====
 
−
<pre>code=</pre>
 
−
Values:
 
−
==== Selecting a photo ====
 
−
<pre>imgid=</pre>
 
−
Values:
 
−
==== Rotating a photo ====
 
−
<pre>Test server: https://world.openfoodfacts.net/cgi/product_image_rotate.pl</pre>
 
−
<pre>Live server: https://world.openfoodfacts.org/cgi/product_image_rotate.pl</pre>
 
−
===== Values and output =====
 
−
Parameters:
 
−
<pre>
 
−
imgid =
 
−
code = BARCODE
 
−
angle = Angle of the rotation - 90° increments
 
−
normalize = whether the source image should be normalized
 
−
white_magic = whether the source image should be "white magic"'d ( background removal)
 
−
</pre>
 
−
 
 
−
<pre>function update_image(imagefield) {
 
−
 
 
−
$('#crop_' + imagefield).attr("src","/cgi/product_image_rotate.pl?code=" + code + "&imgid=" + imagefield_imgid[imagefield]
 
−
+ "&angle=" + angles[imagefield] + "&normalize=" + $("#normalize_" + imagefield).prop('checked')
 
−
+ "&white_magic=" + $("#white_magic_" + imagefield).prop('checked') );
 
−
$('div[id="cropbuttonmsg_' + imagefield +'"]').hide();
 
−
}
 
−
</pre>
 
−
 
 
−
==== Removing background on a photo ("White magic") ====
 
−
This will work best on photos with a white background. Best use case is to let user try it and give up if the result is not satisfying.
 
−
<pre>white_magic=</pre>
 
−
Values:
 
−
 
 
−
==== Color correction on a photo ("Normalize")====
 
−
<pre>normalize=</pre>
 
−
Values:
 
−
 
 
−
==== Cropping a photo ====
 
−
This implies applying operations to a source image (not only cropping, but all the others if applicable). We start from a source image (defined by a barcode and incremental id), apply cropping parameters (x1, y1, x2, y2), additional operations (white_magic, normalize)
 
−
<br>
 
−
 
 
−
<pre>Test server: https://world.openfoodfacts.net/cgi/product_image_crop.pl</pre>
 
−
<pre>Live server: https://world.openfoodfacts.org/cgi/product_image_crop.pl</pre>
 
−
=====Values=====
 
−
<pre>
 
−
code=BARCODE
 
−
id=
 
−
angle= Angle of the rotation
 
−
normalize = whether the source image should be normalized
 
−
white_magic = whether the source image should be white magiced ( background removal)
 
−
type = add
 
−
action = display
 
−
imgid =
 
−
x1= the X origin of the crop
 
−
y1=the Y origin of the crop
 
−
x2=the X end of the crop
 
−
y2=the Y end of the crop
 
−
</pre>
 
−
 
 
−
===== Ignore me =====
 
−
<pre>$.post('/cgi/product_image_crop.pl',
 
−
{code: code, id: imagefield , imgid: imgid,
 
−
x1:selection.x, y1:selection.y, x2:selection.x + selection.width, y2:selection.y + selection.height,
 
−
angle:angles[imagefield], normalize:$("#normalize_" + imagefield).prop('checked'),
 
−
white_magic:$("#white_magic_" + imagefield).prop('checked') }, function(data) {
 
−
 
−
imagefield_url[imagefield] = data.image.display_url;
 
−
update_display(imagefield, false);
 
−
$('div[id="cropbutton_' + imagefield +'"]').show();
 
−
$('div[id="cropbuttonmsg_' + imagefield +'"]').html(Lang.image_saved);
 
−
$(document).foundation('equalizer', 'reflow');
 
−
}, 'json');
 
−
}); </pre>
 
−
 
 
−
==== Performing OCR on a photo ====
 
−
We start from a source image (defined by barcode and id) as selected for ingredients. We ask Product Opener to process it (process_image=1). Product Opener returns a JSON. Processing is done using Tesseract (3 on preprod). The result is often cripped with errors. Take steps to avoid direct copy pasting into the ingredients field by your users.
 
−
 
 
−
<pre>Test server: https://world.openfoodfacts.net/cgi/ingredients.pl</pre>
 
−
<pre>Live server: https://world.openfoodfacts.net/cgi/ingredients.pl</pre>
 
−
===== Values and output =====
 
−
<pre>
 
−
code=code
 
−
id=imagefield
 
−
process_image=1
 
−
</pre>
 
−
 
 
−
This will return JSON
 
−
 
 
−
===== Ignore me =====
 
−
<pre>
 
−
$.post('/cgi/ingredients.pl',
 
−
{ }, function(data) {
 
−
 
−
if (data.status == 0) {
 
−
$('div[id="ocrbuttondiv_' + imagefield +'"]').html(Lang.extracted_ingredients_ok);
 
−
var ingredients_text_id = imagefield.replace("ingredients","ingredients_text");
 
−
$("#" + ingredients_text_id).val(data.ingredients_text_from_image);
 
−
}
 
−
else {
 
−
$('div[id="ocrbuttondiv_' + imagefield +'"]').html(Lang.extracted_ingredients_nok);
 
−
}
 
−
$(document).foundation('equalizer', 'reflow');
 
−
}, 'json');
 
−
</pre>
 
−
 
 
−
=== Posting a new product ===
 
−
* Do a GET request, otherwise you'll get <pre> {“status_verbose”: “no code or invalid code”,“status”: 0}</pre>
 
−
* URL: <pre>https://world.openfoodfacts.org/cgi/product_jqm2.pl</pre> (Product post)<sup>(remember to do tests on world.openfoodfacts.net - login and password: off )</sup>
 
−
* URL for your tests : <pre>https://world.openfoodfacts.net/cgi/product_jqm2.pl</pre>
 
−
==== Quick overview ====
 
−
* var foodfact = { barcode : '0048151623426', name : 'Product name', 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      : "Walmart",
 
−
* nutriment_energy      :foodfact.energy,
 
−
* nutriment_energy_unit :foodfact.energy_unit,
 
−
* nutrition_data_per    :"serving"
 
−
 
 
−
=====Status after save =====
 
−
* {"status_verbose":"fields saved","status":1}
 
−
 
 
−
==== Example ====
 
−
<sup>(remember to do tests on world.openfoodfacts.net - login and password: off)</sup><br>
 
−
===== Query 1 : Unauthentified query =====
 
−
<pre>https://world.openfoodfacts.net/cgi/product_jqm2.pl?code=0048151623426&product_name=Maryland%20Choc%20Chip&quantity=230g&brand=Golden%20Cookies&nutriment_energy=450&nutriment_energy_unit=kJ&nutrition_data_per=serving&ingredients_text=Fortified%20wheat%20flour%2C%20Chocolate%20chips%20%2825%25%29%2C%20Sugar%2C%20Palm%20oil%2C%20Golden%20syrup%2C%20Whey%20and%20whey%20derivatives%20%28Milk%29%2C%20Raising%20agents%2C%20Salt%2C%20Flavouring&traces=Milk%2C+Soya%2C+Nuts%2C+Wheat</pre>
 
−
 
 
−
===== Result 2 =====
 
−
<pre>https://uk.openfoodfacts.net/product/0072417136160/maryland-choc-chip</pre>
 
−
 
 
−
===== Query 2 : Authentified query =====
 
−
<pre>https://world.openfoodfacts.org/cgi/product_jqm2.pl?code=0048151623426&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</pre>
 
−
 
 
−
===== Result 2 =====
 
−
====== If credentials are correct ======
 
−
<pre>Standard success status, see above</pre>
 
−
====== If credentials are not correct ======
 
−
Will give you a responsive HTML login page.
 
−
 
 
−
==== See editing a product for details on fields ====
 
−
==== Posting several values for a field ====
 
−
When adding values, send to the field labels as comma separated values that are canonicalised and added to the _tags array
 
−
<pre>labels = "labelA, labelB"</pre>
 
−
Reading back, use labels_tags to get an array of labels
 
−
 
 
−
=== Editing an existing product ===
 
−
==== Posting additional photos ====
 
−
* Photos post on /cgi/product_image_upload.pl
 
−
** code: the barcode
 
−
** imagefield: (front | ingredients | nutrition)
 
−
===== Add more pictures without selecting them =====
 
−
* imagefield: (other)
 
−
 
 
−
===== Select the Front picture =====
 
−
* imgupload_front : your image file if imagefield:front
 
−
===== Select the Ingredients picture =====
 
−
* imgupload_ingredients: your image file if imagefield:ingredients
 
−
===== Select the Nutrition Facts picture =====
 
−
* imgupload_nutrition: your image file if imagefield:nutrition
 
−
 
 
−
==== Editing the product ====
 
−
==== Give the barcode ====
 
−
<pre>code=072417136160</pre>
 
−
 
 
−
 
 
−
==== Add the brand ====
 
−
<pre>brand=Heinz</pre>
 
−
 
 
−
==== Add the name ====
 
−
<pre>product_name=Maryland%20Choc%20Chip</pre>
 
−
==== Add the quantity ====
 
−
<pre>quantity=230g</pre>
 
−
==== Add the packager code ====
 
−
<pre>emb_codes_tag=EMB%2013330</pre>
 
−
==== Add the packaging type ====
 
−
<pre>packaging=Cardboard</pre>
 
−
 
 
−
==== Add the labels ====
 
−
<pre>labels=Vegan%2C%20Fat%20free</pre>
 
−
 
 
−
==== Add the Stores where bought ====
 
−
<pre>stores=Intermarch%C3%A9</pre>
 
−
==== Add the category ====
 
−
<pre>categories=Cookies</pre>
 
−
==== Add the best before date ====
 
−
<pre>expiration_date=</pre>
 
−
 
 
−
==== Add the link to the official webpage of the product ====
 
−
<pre>link=</pre>
 
−
 
 
−
==== Add the ingredients ====
 
−
<pre>ingredients_text=Fortified%20wheat%20flour%2C%20Chocolate%20chips%20%2825%25%29%2C%20Sugar%2C%20Palm%20oil%2C%20Golden%20syrup%2C%20Whey%20and%20whey%20derivatives%20%28Milk%29%2C%20Raising%20agents%2C%20Salt%2C%20Flavouring</pre>
 
−
==== Add ingredient traces ====
 
−
<pre>traces=Milk%2C+Soya%2C+Nuts%2C+Wheat</pre>
 
−
 
 
−
==== Add the main language ====
 
−
You can set the main language of the product.<br>
 
−
<pre>lang=fr</pre><br><br>
 
−
(NOT LIVE YET)
 
−
In the case of a multilingual product, you can specify the main language of the product, and you can then specify values and images for different languages by suffixing the language code to the other fields.
 
−
 
 
−
==== Add the nutrition facts ====
 
−
===== Indicate the absence of nutrition facts =====
 
−
<pre>no_nutriments : indicates if the nutrition facts are indicated on the food label</pre>
 
−
===== Add nutrition facts values, units and base =====
 
−
====== Define the basis for the values ======
 
−
<pre>nutrition_data_per=100g</pre>
 
−
<br>'''OR'''<br>
 
−
<pre>nutrition_data_per=serving</pre>
 
−
<pre>serving_size=38g</pre>
 
−
 
 
−
====== Input values and units ======
 
−
<pre>nutriment_energy=450</pre>
 
−
<pre>nutriment_energy_unit=kJ</pre>
 
−
 
 
−
====== Values ======
 
−
<pre>
 
−
nutriment_energy
 
−
nutriment_proteins
 
−
nutriment_casein
 
−
nutriment_serum-proteins
 
−
nutriment_nucleotides
 
−
nutriment_carbohydrates
 
−
nutriment_sugars
 
−
nutriment_sucrose
 
−
nutriment_glucose
 
−
nutriment_fructose
 
−
nutriment_lactose
 
−
nutriment_maltose
 
−
nutriment_maltodextrins
 
−
nutriment_starch
 
−
nutriment_polyols
 
−
nutriment_fat
 
−
nutriment_saturated-fat
 
−
nutriment_butyric-acid
 
−
nutriment_caproic-acid
 
−
nutriment_caprylic-acid
 
−
nutriment_capric-acid
 
−
nutriment_lauric-acid
 
−
nutriment_myristic-acid
 
−
nutriment_palmitic-acid
 
−
nutriment_stearic-acid
 
−
nutriment_arachidic-acid
 
−
nutriment_behenic-acid
 
−
nutriment_lignoceric-acid
 
−
nutriment_cerotic-acid
 
−
nutriment_montanic-acid
 
−
nutriment_melissic-acid
 
−
nutriment_monounsaturated-fat
 
−
nutriment_polyunsaturated-fat
 
−
nutriment_omega-3-fat
 
−
nutriment_alpha-linolenic-acid
 
−
nutriment_eicosapentaenoic-acid
 
−
nutriment_docosahexaenoic-acid
 
−
nutriment_omega-6-fat
 
−
nutriment_linoleic-acid
 
−
nutriment_arachidonic-acid
 
−
nutriment_gamma-linolenic-acid
 
−
nutriment_dihomo-gamma-linolenic-acid
 
−
nutriment_omega-9-fat
 
−
nutriment_oleic-acid
 
−
nutriment_elaidic-acid
 
−
nutriment_gondoic-acid
 
−
nutriment_mead-acid
 
−
nutriment_erucic-acid
 
−
nutriment_nervonic-acid
 
−
nutriment_trans-fat
 
−
nutriment_cholesterol
 
−
nutriment_fiber
 
−
nutriment_sodium
 
−
nutriment_alcohol : % vol of alcohol
 
−
nutriment_vitamin-a
 
−
nutriment_vitamin-d
 
−
nutriment_vitamin-e
 
−
nutriment_vitamin-k
 
−
nutriment_vitamin-c
 
−
nutriment_vitamin-b1
 
−
nutriment_vitamin-b2
 
−
nutriment_vitamin-pp
 
−
nutriment_vitamin-b6
 
−
nutriment_vitamin-b9
 
−
nutriment_vitamin-b12
 
−
nutriment_biotin
 
−
nutriment_pantothenic-acid
 
−
nutriment_silica
 
−
nutriment_bicarbonate
 
−
nutriment_potassium
 
−
nutriment_chloride
 
−
nutriment_calcium
 
−
nutriment_phosphorus
 
−
nutriment_iron
 
−
nutriment_magnesium
 
−
nutriment_zinc
 
−
nutriment_copper
 
−
nutriment_manganese
 
−
nutriment_fluoride
 
−
nutriment_selenium
 
−
nutriment_chromium
 
−
nutriment_molybdenum
 
−
nutriment_iodine
 
−
nutriment_caffeine
 
−
nutriment_taurine
 
−
nutriment_ph : pH (no unit)
 
−
</pre>
 
−
 
 
−
====== Units ======
 
−
<pre>
 
−
nutriment_energy_unit
 
−
nutriment_proteins_unit
 
−
nutriment_casein_unit
 
−
nutriment_serum-proteins_unit
 
−
nutriment_nucleotides_unit
 
−
nutriment_carbohydrates_unit
 
−
nutriment_sugars_unit
 
−
nutriment_sucrose_unit
 
−
nutriment_glucose_unit
 
−
nutriment_fructose_unit
 
−
nutriment_lactose_unit
 
−
nutriment_maltose_unit
 
−
nutriment_maltodextrins_unit
 
−
nutriment_starch_unit
 
−
nutriment_polyols_unit
 
−
nutriment_fat_unit
 
−
nutriment_saturated-fat_unit
 
−
nutriment_butyric-acid_unit
 
−
nutriment_caproic-acid_unit
 
−
nutriment_caprylic-acid_unit
 
−
nutriment_capric-acid_unit
 
−
nutriment_lauric-acid_unit
 
−
nutriment_myristic-acid_unit
 
−
nutriment_palmitic-acid_unit
 
−
nutriment_stearic-acid_unit
 
−
nutriment_arachidic-acid_unit
 
−
nutriment_behenic-acid_unit
 
−
nutriment_lignoceric-acid_unit
 
−
nutriment_cerotic-acid_unit
 
−
nutriment_montanic-acid_unit
 
−
nutriment_melissic-acid_unit
 
−
nutriment_monounsaturated-fat_unit
 
−
nutriment_polyunsaturated-fat_unit
 
−
nutriment_omega-3-fat_unit
 
−
nutriment_alpha-linolenic-acid_unit
 
−
nutriment_eicosapentaenoic-acid_unit
 
−
nutriment_docosahexaenoic-acid_unit
 
−
nutriment_omega-6-fat_unit
 
−
nutriment_linoleic-acid_unit
 
−
nutriment_arachidonic-acid_unit
 
−
nutriment_gamma-linolenic-acid_unit
 
−
nutriment_dihomo-gamma-linolenic-acid_unit
 
−
nutriment_omega-9-fat_unit
 
−
nutriment_oleic-acid_unit
 
−
nutriment_elaidic-acid_unit
 
−
nutriment_gondoic-acid_unit
 
−
nutriment_mead-acid_unit
 
−
nutriment_erucic-acid_unit
 
−
nutriment_nervonic-acid_unit
 
−
nutriment_trans-fat_unit
 
−
nutriment_cholesterol_unit
 
−
nutriment_fiber_unit
 
−
nutriment_sodium_unit
 
−
nutriment_alcohol_unit : % vol of alcohol
 
−
nutriment_vitamin-a_unit
 
−
nutriment_vitamin-d_unit
 
−
nutriment_vitamin-e_unit
 
−
nutriment_vitamin-k_unit
 
−
nutriment_vitamin-c_unit
 
−
nutriment_vitamin-b1_unit
 
−
nutriment_vitamin-b2_unit
 
−
nutriment_vitamin-pp_unit
 
−
nutriment_vitamin-b6_unit
 
−
nutriment_vitamin-b9_unit
 
−
nutriment_vitamin-b12_unit
 
−
nutriment_biotin_unit
 
−
nutriment_pantothenic-acid_unit
 
−
nutriment_silica_unit
 
−
nutriment_bicarbonate_unit
 
−
nutriment_potassium_unit
 
−
nutriment_chloride_unit
 
−
nutriment_calcium_unit
 
−
nutriment_phosphorus_unit
 
−
nutriment_iron_unit
 
−
nutriment_magnesium_unit
 
−
nutriment_zinc_unit
 
−
nutriment_copper_unit
 
−
nutriment_manganese_unit
 
−
nutriment_fluoride_unit
 
−
nutriment_selenium_unit
 
−
nutriment_chromium_unit
 
−
nutriment_molybdenum_unit
 
−
nutriment_iodine_unit
 
−
nutriment_caffeine_unit
 
−
nutriment_taurine_unit
 
−
nutriment_ph_unit : pH (no unit)
 
−
</pre>
 
−
 
 
−
===== Adding the alcohol % of wine =====
 
−
12% wine
 
−
<pre>nutriment_unit=%25%20vol&nutriment_alcohol=12</pre>
 
−
 
 
−
===== Adding the carbon footprint =====
 
−
<pre>nutriment_carbon-footprint</pre>
 
−
<pre>nutriment_carbon-footprint_unit</pre>
 
−
 
 
−
=== Adding a comment to your edit ===
 
−
<pre>comment=Automated%20Edit</pre>
 
  
 
== Open Pet Food Facts ==
 
== Open Pet Food Facts ==
Line 1,649: Line 87:
 
* https://ssl-api.openpetfoodfacts.org/api/v0/product/20106836.json
 
* https://ssl-api.openpetfoodfacts.org/api/v0/product/20106836.json
  
−
== Open Beauty Facts experimental and specific APIs ==
+
== Open Beauty Facts ==
−
=== Product in Open Beauty Facts ===
 
−
* https://ssl-api.openbeautyfacts.org/api/v0/product/3560070791460.json
 
−
 
 
−
=== Ingredients ===
 
−
'''Very experimental. Do not rely on this for allergen or ingredient parsing yet.'''
 
−
==== List of ingredients detected by the current experimental parser ====
 
−
* https://world.openbeautyfacts.org/ingredients.json
 
−
* https://world.openbeautyfacts.org/ingredients.xml
 
−
==== Products where the current experimental parser could not detect aluminium salts ====
 
−
* https://world.openbeautyfacts.org/ingredient/-aluminum-salts.json
 
−
* https://world.openbeautyfacts.org/ingredient/-aluminum-salts.xml
 
−
==== Products where the current experimental parser could detect aluminium salts ====
 
−
* https://world.openbeautyfacts.org/ingredient/aluminum-salts.json
 
−
* https://world.openbeautyfacts.org/ingredient/aluminum-salts.xml
 
−
=== Periods after Opening ===
 
−
[https://en.wiki.openbeautyfacts.org/Global_period_after_opening_taxonomy Periods after opening taxonomy]
 
−
==== List of periods after opening ====
 
−
* https://world.openbeautyfacts.org/periods-after-opening.json
 
−
* https://world.openbeautyfacts.org/periods-after-opening.xml
 
−
==== List of products with a given period after opening ====
 
−
* https://world.openbeautyfacts.org/period-after-opening/12-months.json
 
−
* https://world.openbeautyfacts.org/period-after-opening/12-months.xml
 
−
 
 
−
====Values ====
 
−
* https://ssl-api.openbeautyfacts.org/api/v0/product/3560070791460.json
 
−
* https://en.wiki.openbeautyfacts.org/Global_periods_after_opening_taxonomy
 
−
<pre>
 
−
"periods_after_opening_tags":["en:12-months"]
 
−
"periods_after_opening_hierarchy":["en:12-months"]
 
−
"periods_after_opening":"12 M"
 
−
"periods_after_opening_debug_tags":[]</pre>
 
  
−
====Images ====
+
[[API/OpenBeautyFacts]]
−
No API is currently available, but the image path is predictable.
 
−
<pre>
 
−
https://static.openbeautyfacts.org/images/lang/en/periods_after_opening/1-months.90x90.svg
 
−
…
 
−
https://static.openbeautyfacts.org/images/lang/en/periods_after_opening/12-months.90x90.svg
 
−
</pre>
 

Revision as of 15:32, 30 March 2018


Introduction

Current status of the API

Getting help with the API

You can ask for help on using the API in this API channel on Slack. Join us to discuss your use case and get help/code from other devs.

How to test the API

READ operations

Technical details
  • You can do READ operations using production
  • You should now use the SSL version of the API. The unsecure version WILL be deprecated :-)
https://ssl-api.openfoodfacts.org
Licence

Open Food Facts is under the OdBL licence (database) and CC-BY-SA (pictures). That has a couple of legal implications. Please join us on the Slack channel to discuss them.

WRITE operations

Use cases
  • You can add photos and informations to Open Food Facts using the API.
    • Letting your users add new products by uploading photos is the most common use case.
    • Several apps already enable more advanced editing. Gamification would be welcome.
  • The official mobile apps can use some help.
A few things
  • Do join the API channel if you intend on using WRITE
  • Do not send copyrighted photos or information using the API. Everything you send is OdBL for the data, and CC-BY-SA for the pictures. If those are not yours (eg from scraping), you bear all the legal consequences.
  • You can create a global account for your app if you don't want to implement Open Food Facts user creation in your app right now. Please report it in #api so that it can be monitored for errors.
  • You should do all your test edits on https://world.openfoodfacts.net (ask for the password on Slack)

Conventions for the API

  • fields that end with _t are dates in the UNIX timestamp format (number of seconds since Jan 1st 1970)
  • fields that end with _datetime are dates in the iso8601 format: yyyy-mm-ddThh:mn:ssZ
  • fields that end with _tags are comma separated list of tags (e.g. categories_tags is the set of normalized tags computer from the categories field)
  • fields that end with a language 2 letter code (e.g. fr for French) is the set of tags in that language
  • fields that end with _100g correspond to the amount of a nutriment (in g) for 100 g or 100 ml of product

Language Bindings

Roadmap

API/Roadmap

Bugs

Reporting bugs

  • Do not hesitate to file a bug if you find an issue in the API, or need an improvement.

Known bugs

Warning

  • Some products are incomplete.
  • You should ensure your UX tells the final user that the product is not complete, encourage them to exercise caution and/or help complete the product.
  • When doing averages, computations… filter incomplete products to avoid issues
  • Assume the data is not reliable until the product is marked as complete.
  • In general, ensure the user exercises maintains caution (for allergens…) and be upfront about possible risks.


Read API

API/Read

Write API

API/Write

Open Pet Food Facts

Open Pet Food Facts behaves just like Open Food Facts. Behaviours may change over time, as we tweak it.

Open Beauty Facts

API/OpenBeautyFacts

Retrieved from "https://wiki.openfoodfacts.org/index.php?title=API&oldid=7075"