Difference between revisions of "API"

From Open Food Facts wiki
Jump to navigation Jump to search
Line 152: Line 152:
 
* http://world.openfoodfacts.org/country/france.json
 
* http://world.openfoodfacts.org/country/france.json
 
* http://world.openfoodfacts.org/country/france.xml
 
* http://world.openfoodfacts.org/country/france.xml
 +
==== Ingredients ====
 +
===== List of detected ingredients =====
 +
* http://world.openfoodfacts.org/ingredients.json
 +
* http://world.openfoodfacts.org/ingredients.xml
 +
 +
===== List of products where an ingredient has been detected =====
 +
* http://world.openfoodfacts.org/ingredient/sucre.xml
 +
* http://world.openfoodfacts.org/ingredient/sucre.json
 +
<pre>Do not make the assumption that the ingredient is or is not present based on this. Parsing errors happen.</pre>
 
====Trace of products====
 
====Trace of products====
 
=====List of Traces =====
 
=====List of Traces =====

Revision as of 07:55, 12 May 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 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

You can ask for help on using the API in this [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

READ API Documentation

Static data

http://world.openfoodfacts.org/data

Field reference

The fields used in the api. 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:

Reading a product

See http://fr.openfoodfacts.org/data or http://en.openfoodfacts.org/data The requested subdomain will be the locale fetched.

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 graphical advanced search on the site

  • 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(remember to do tests on world.openfoodfacts.net - login and password: off )
http://world.openfoodfacts.org/cgi/search.pl?search_terms=coke&search_simple=1&jqm=1
http://world.openfoodfacts.org/cgi/search.pl?search_terms=banania&search_simple=1&action=process&json=1
http://world.openfoodfacts.org/cgi/search.pl?search_terms=banania&search_simple=1&action=process&xml=1
Generic Search
Combining Tags to get custom results

Combining tags works, letting you create thousands of APIs

Languages

Languages on the packaging of the product. Currently live on Open Beauty Facts. On the Testing version of Open Food Facts. Soon on the live Open Food Facts.

List of languages present on packaging
List of products with given language on packaging
List of multilingual products
List of products by language count

Labels

List of labels
Individual label

Categories

List of categories
Individual category

Status of products

List of States
Individual Status

Packaging

List of Packagings
Individual Packaging

Brands

List of Brands
Individual Brand

Purchase Place of products

List of Purchase Place
Individual Purchase Place

Store of products

List of Stores
Individual Store

Country of products

List of Countries
Individual Country

Ingredients

List of detected ingredients
List of products where an ingredient has been detected
Do not make the assumption that the ingredient is or is not present based on this. Parsing errors happen.

Trace of products

List of Traces
Individual Trace

Additive of products

List of Additives
Individual Additive

allergens of products

List of allergens
Individual allergen

Barcodes

List of List of barcodes beginning with a given number
List of barcodes beginning with 3596710

Entry dates

List of entry dates
List of products with a given entry date

Packager codes

List of Packager codes
List of products with given Packager code
List of Packaging cities

http://world.openbeautyfacts.org/cities.json http://world.openbeautyfacts.org/cities.xml

List of products with given Packaging city

WRITE API Documentation

Posting photos

  • Use the POST method 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

Important:

  • 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


Example: (remember to do tests on world.openfoodfacts.net - login and password: off ) 

http://world.openfoodfacts.org/cgi/product_image_upload.pl

http://world.openfoodfacts.net/cgi/product_image_upload.pl?code=654345678

Posting a new product

  • URL for your tests : 
    http://world.openfoodfacts.net/cgi/product_jqm2.pl

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

(remember to do tests on world.openfoodfacts.net - login and password: off)

Query 1
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
Result 2
http://uk.openfoodfacts.net/product/0072417136160/maryland-choc-chip
Query 2
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
Result 2


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 canonicalized and added to the _tags array



labels = "labelA, labelB"


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)


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


code=072417136160







Add the brand


brand=Heinz


Add the name


product_name=Maryland%20Choc%20Chip


Add the quantity


quantity=230g


Add the packager code


emb_codes=EMB%2013330


Add the packaging type


packaging=Cardboard


Add the labels


labels=Vegan%2C%20Fat%20free


Add the Stores where bought


stores=Intermarch%C3%A9


Add the category


categories=Cookies


Add the best before date


expiration_date=


Add the link to the official webpage of the product


link=


Add the ingredients


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


Add ingredient traces


traces=Milk%2C+Soya%2C+Nuts%2C+Wheat


Add the main language


You can set the main language of the product.




lang=fr




(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


no_nutriments : indicates if the nutrition facts are indicated on the food label


Add nutrition facts values, units and base


Define the basis for the values


nutrition_data_per=100g



OR




nutrition_data_per=serving


serving_size=38g


Input values and units


nutriment_energy=450


nutriment_energy_unit=kJ


Values


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)



Units


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)



Adding the alcohol % of wine


12% wine



nutriment_unit=%25%20vol&nutriment_alcohol=12


Adding the carbon footprint


nutriment_carbon-footprint


nutriment_carbon-footprint_unit


Adding a comment to your edit


comment=Automated%20Edit


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



Products where the current experimental parser could not detect aluminium salts



Products where the current experimental parser could detect aluminium salts



Period after Opening



List of products with a given Period after Opening



Roadmap


API/Roadmap



Language Bindings





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