Difference between revisions of "API"

From Open Food Facts wiki
Jump to navigation Jump to search
(adding search "API")
 
(388 intermediate revisions by 21 users not shown)
Line 1: Line 1:
== TODO ==
+
__NOINDEX__
* Translate the data page (http://fr.openfoodfacts.org/data) in English and make it available on all subdomains
+
[[Category:Developer]] [[Category:API]]
* Document all APIs
+
The API (Application Programming Interface) is the way an application can enter in dialogue with Open Food Facts application server.
  
== API Basic Documentation ==
+
All information about the API can be found [https://openfoodfacts.github.io/openfoodfacts-server/api/ in the documentation].
=== Reading a product ===
 
See http://fr.openfoodfacts.org/data or http://en.openfoodfacts.org/data
 
 
 
 
 
=== Searching for products ===
 
 
 
You can add &jqm=1 to search results pages on the web site to get results in a jquerymobile format.
 
 
 
e.g. http://world.openfoodfacts.org/cgi/search.pl?search_terms=coke&search_simple=1&jqm=1
 
 
 
=== Posting photos ===
 
* Photos post on /cgi/product_image_upload.pl
 
:code: the barcode
 
:imagefield: "front"
 
:imgupload_front : your image file
 
 
 
=== Posting a new product ===
 
* Product post to http://fr.openfoodfacts.org/cgi/product_jqm2.pl
 
 
 
:var foodfact = { barcode : '3073780969000', name : 'KIRI GOUTER 280G 8 PORTIONS', energy: 500, energy_unit: "kJ", weight: 282 };
 
:var postData = {
 
:code        : foodfact.barcode,
 
:user_id      : "mesinfosnutritionelles",
 
:password    : "****",
 
:product_name : foodfact.name?foodfact.name:foodfact.shop_label,
 
:quantity    : foodfact.weight?""+foodfact.weight+" g":undefined,
 
:stores      : "Intermarché",
 
:nutriment_energy      :foodfact.energy,
 
:nutriment_energy_unit :foodfact.energy_unit,
 
:nutrition_data_per    :"serving"
 
:{"status_verbose":"fields saved","status":1}
 
* 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
 

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.