Difference between revisions of "API"

From Open Food Facts wiki
Jump to navigation Jump to search
 
(287 intermediate revisions by 18 users not shown)
Line 1: Line 1:
[[Category:Developer]]
+
__NOINDEX__
[[Category:API]]
+
[[Category:Developer]] [[Category:API]]
== Status ==
+
The API (Application Programming Interface) is the way an application can enter in dialogue with Open Food Facts application server.
Currently the API is mainly used internally for [[Project:Mobile_Apps|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 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)
 
  
== Getting help with the API ==
+
All information about the API can be found [https://openfoodfacts.github.io/openfoodfacts-server/api/ in the documentation].
You can ask for help on using the API in this [[https://openfoodfacts.slack.com/messages/api/|API channel on Slack]].
 
 
 
== 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.
 
== Bugs ==
 
* Do not hesitate to file a bug if you find an issue in the API, or need an improvement.
 
* https://github.com/openfoodfacts/openfoodfacts-server/issues
 
 
 
== READ API Documentation ==
 
=== Static data ===
 
http://world.openfoodfacts.org/data
 
=== Field reference ===
 
http://world.openfoodfacts.org/data/data-fields.txt
 
=== JSON interface ===
 
=== 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
 
 
 
==== Fields within a product ====
 
===== Images =====
 
* image_small_url
 
* image_thumb_url
 
* image_url
 
====== Front ======
 
* "image_front_url"
 
* "image_front_small_url"
 
* "image_front_thumb_url"
 
====== Ingredients ======
 
* "image_ingredients_url"
 
* "image_ingredients_small_url"
 
* "image_ingredients_thumb_url"
 
====== Nutrition ======
 
* "image_nutrition_url"
 
* "image_nutrition_small_url"
 
* "image_nutrition_thumb_url"
 
 
 
=== Searching for products ===
 
==== General principles ====
 
===== Advanced Search =====
 
====== Parameters ======
 
You can basically use all the parameters you'd use in a [http://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>
 
* 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.
 
===== Examples<sup>(remember to do tests on world.openfoodfacts.net - login and password: off )</sup> =====
 
<pre>http://world.openfoodfacts.org/cgi/search.pl?search_terms=coke&search_simple=1&jqm=1</pre>
 
<pre>http://world.openfoodfacts.org/cgi/search.pl?search_terms=banania&search_simple=1&action=process&json=1</pre>
 
<pre>http://world.openfoodfacts.org/cgi/search.pl?search_terms=banania&search_simple=1&action=process&xml=1</pre>
 
 
 
===== Generic Search =====
 
====== Combining Tags to get custom results ======
 
Combining tags works, letting you create thousands of APIs
 
* http://world.openfoodfacts.org/packager-code/emb-35069c/brand/sojasun.json
 
 
 
==== Languages ====
 
Languages on the packaging of the product.Currently live on Open Beauty Facts. Soon on Open Food Facts
 
* http://world.openbeautyfacts.org/languages.json
 
* http://world.openbeautyfacts.org/languages.xml
 
 
 
====Labels====
 
=====List of labels=====
 
* http://world.openfoodfacts.org/labels.json
 
* http://world.openfoodfacts.org/labels.xml
 
=====Individual label=====
 
* http://world.openfoodfacts.org/label/utz-certified.json
 
* http://world.openfoodfacts.org/label/utz-certified.xml
 
====Categories====
 
=====List of categories=====
 
* http://world.openfoodfacts.org/categories.json
 
* http://world.openfoodfacts.org/categories.xml
 
=====Individual category=====
 
* http://world.openfoodfacts.org/category/baby-foods.json
 
* http://world.openfoodfacts.org/category/baby-foods.xml
 
====Status of products====
 
=====List of States =====
 
* http://world.openfoodfacts.org/states.json
 
* http://world.openfoodfacts.org/states.xml
 
=====Individual Status =====
 
* http://world.openfoodfacts.org/state/complete.json
 
* http://world.openfoodfacts.org/state/complete.xml
 
====Packaging====
 
=====List of Packagings=====
 
* http://world.openfoodfacts.org/packaging.json
 
* http://world.openfoodfacts.org/packaging.xml
 
 
 
=====Individual Packaging=====
 
* http://world.openfoodfacts.org/packaging/cardboard.json
 
* http://world.openfoodfacts.org/packaging/cardboard.xml
 
====Brands====
 
=====List of Brands=====
 
* http://world.openfoodfacts.org/brands.json
 
* http://world.openfoodfacts.org/brands.xml
 
=====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=====
 
* http://world.openfoodfacts.org/stores.json
 
* http://world.openfoodfacts.org/stores.xml
 
=====Individual Store=====
 
* http://world.openfoodfacts.org/store/super-u.json
 
* http://world.openfoodfacts.org/store/super-u.xml
 
====Country of products====
 
=====List of Countries =====
 
* http://world.openfoodfacts.org/countries.json
 
* http://world.openfoodfacts.org/countries.xml
 
=====Individual Country =====
 
* http://world.openfoodfacts.org/country/france.json
 
* http://world.openfoodfacts.org/country/france.xml
 
====Trace of products====
 
=====List of Traces =====
 
* http://world.openfoodfacts.org/traces.json
 
* http://world.openfoodfacts.org/traces.xml
 
=====Individual Trace =====
 
* http://world.openfoodfacts.org/trace/eggs.json
 
* http://world.openfoodfacts.org/trace/eggs.xml
 
 
 
====Additive of products====
 
=====List of Additives =====
 
* http://world.openfoodfacts.org/additives.json
 
* http://world.openfoodfacts.org/additives.xml
 
=====Individual Additive=====
 
* http://world.openfoodfacts.org/additive/e301-sodium-ascorbate.json
 
* http://world.openfoodfacts.org/additive/e301-sodium-ascorbate.xml
 
====allergens of products====
 
=====List of allergens=====
 
* http://world.openfoodfacts.org/allergens.json
 
* http://world.openfoodfacts.org/allergens.xml
 
=====Individual allergen=====
 
* http://world.openfoodfacts.org/allergen/fish.json
 
* http://world.openfoodfacts.org/allergen/fish.xml
 
 
 
====Barcodes====
 
=====List of List of barcodes beginning with a given number =====
 
* http://world.openfoodfacts.org/codes.json
 
* http://world.openfoodfacts.org/codes.xml
 
 
 
=====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 =====
 
* http://world.openfoodfacts.org/entry-dates.json
 
* http://world.openfoodfacts.org/entry-dates.xml
 
=====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
 
 
 
=====List of Packaging cities =====
 
http://world.openbeautyfacts.org/cities.json
 
http://world.openbeautyfacts.org/cities.xml
 
 
 
=====List of products with given Packaging city =====
 
* http://world.openbeautyfacts.org/city/argenteuil-val-d-oise-france.json
 
* http://world.openbeautyfacts.org/city/argenteuil-val-d-oise-france.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 if imagefield:front
 
** imgupload_ingredients: your image file if imagefield:ingredients
 
** imgupload_nutrition: your image file if imagefield:nutrition
 
 
 
Example: <sup>(remember to do tests on world.openfoodfacts.net - login and password: off )</sup>
 
<pre>
 
http://world.openfoodfacts.org/cgi/product_image_upload.pl
 
</pre>
 
 
 
=== Posting a new product ===
 
* Product post to http://world.openfoodfacts.org/cgi/product_jqm2.pl <sup>(remember to do tests on world.openfoodfacts.net - login and password: off )</sup>
 
 
 
* URL for your tests : <pre>http://world.openfoodfacts.net/cgi/product_jqm2.pl</pre>
 
==== Quick overview ====
 
** 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 ====
 
<sup>(remember to do tests on world.openfoodfacts.net - login and password: off)</sup><br>
 
===== Query 1 =====
 
<pre>http://world.openfoodfacts.net/cgi/product_jqm2.pl?code=072417136160&product_name=Maryland%20Choc%20Chip&quantity=230g&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>http://uk.openfoodfacts.net/product/0072417136160/maryland-choc-chip</pre>
 
 
 
===== Query 2 =====
 
<pre>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</pre>
 
===== Result 2 =====
 
<pre></pre>
 
 
 
==== See editing a product for details on fields ====
 
 
 
=== Editing an existing product ===
 
==== Posting additional photos ====
 
* Photos post on /cgi/product_image_upload.pl
 
** code: the barcode
 
** imagefield: (front | ingredients | nutrition)
 
===== 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=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></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 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 =====
 
<pre>nutriment_energy=450</pre>
 
<pre>nutriment_energy_unit=kJ</pre>
 
<pre>nutrition_data_per=serving</pre>
 
<pre>
 
energy_100g
 
proteins_100g
 
casein_100g
 
serum-proteins_100g
 
nucleotides_100g
 
carbohydrates_100g
 
sugars_100g
 
sucrose_100g
 
glucose_100g
 
fructose_100g
 
lactose_100g
 
maltose_100g
 
maltodextrins_100g
 
starch_100g
 
polyols_100g
 
fat_100g
 
saturated-fat_100g
 
butyric-acid_100g
 
caproic-acid_100g
 
caprylic-acid_100g
 
capric-acid_100g
 
lauric-acid_100g
 
myristic-acid_100g
 
palmitic-acid_100g
 
stearic-acid_100g
 
arachidic-acid_100g
 
behenic-acid_100g
 
lignoceric-acid_100g
 
cerotic-acid_100g
 
montanic-acid_100g
 
melissic-acid_100g
 
monounsaturated-fat_100g
 
polyunsaturated-fat_100g
 
omega-3-fat_100g
 
alpha-linolenic-acid_100g
 
eicosapentaenoic-acid_100g
 
docosahexaenoic-acid_100g
 
omega-6-fat_100g
 
linoleic-acid_100g
 
arachidonic-acid_100g
 
gamma-linolenic-acid_100g
 
dihomo-gamma-linolenic-acid_100g
 
omega-9-fat_100g
 
oleic-acid_100g
 
elaidic-acid_100g
 
gondoic-acid_100g
 
mead-acid_100g
 
erucic-acid_100g
 
nervonic-acid_100g
 
trans-fat_100g
 
cholesterol_100g
 
fiber_100g
 
sodium_100g
 
alcohol_100g : % vol of alcohol
 
vitamin-a_100g
 
vitamin-d_100g
 
vitamin-e_100g
 
vitamin-k_100g
 
vitamin-c_100g
 
vitamin-b1_100g
 
vitamin-b2_100g
 
vitamin-pp_100g
 
vitamin-b6_100g
 
vitamin-b9_100g
 
vitamin-b12_100g
 
biotin_100g
 
pantothenic-acid_100g
 
silica_100g
 
bicarbonate_100g
 
potassium_100g
 
chloride_100g
 
calcium_100g
 
phosphorus_100g
 
iron_100g
 
magnesium_100g
 
zinc_100g
 
copper_100g
 
manganese_100g
 
fluoride_100g
 
selenium_100g
 
chromium_100g
 
molybdenum_100g
 
iodine_100g
 
caffeine_100g
 
taurine_100g
 
ph_100g : pH (no unit)
 
</pre>
 
 
 
=== Adding a comment to your edit ===
 
<pre>comment=Automated%20Edit</pre>
 
 
 
== Open Beauty Facts experimental and specific APIs ==
 
=== Ingredients ===
 
Very experimental. Do not rely on this for allergen or ingredient parsing yet.
 
==== List of ingredients detected by the current experimental parser ====
 
* http://world.openbeautyfacts.org/ingredients.json
 
* http://world.openbeautyfacts.org/ingredients.xml
 
 
 
==== Products where the current experimental parser could not detect aluminium salts ====
 
* http://world.openbeautyfacts.org/ingredient/-aluminum-salts.json
 
* http://world.openbeautyfacts.org/ingredient/-aluminum-salts.xml
 
 
 
==== Products where the current experimental parser could detect aluminium salts ====
 
* http://world.openbeautyfacts.org/ingredient/aluminum-salts.json
 
* http://world.openbeautyfacts.org/ingredient/aluminum-salts.xml
 
 
 
=== Period after Opening ===
 
* http://world.openbeautyfacts.org/periods-after-opening.json
 
* http://world.openbeautyfacts.org/periods-after-opening.xml
 
=== List of products with a given Period after Opening ===
 
* http://world.openbeautyfacts.org/period-after-opening/12-months.json
 
* http://world.openbeautyfacts.org/period-after-opening/12-months.xml
 
 
 
== Roadmap ==
 
[[API/Roadmap]]
 
 
 
== Language Bindings==
 
* Ruby bindings - https://github.com/openfoodfacts/openfoodfacts-ruby - gem install openfoodfacts
 
* Python bindings
 

Latest revision as of 14:04, 5 September 2023

The API (Application Programming Interface) is the way an application can enter in dialogue with Open Food Facts application server.

All information about the API can be found in the documentation.