Difference between revisions of "API"

From Open Food Facts wiki
Jump to navigation Jump to search
Line 33: Line 33:
 
==== Advanced Search ====
 
==== Advanced Search ====
 
===== Parameters =====
 
===== 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
 
* sort_by=unique_scans_n
 
* page_size=50 (20 by default, 1000 at most)
 
* page_size=50 (20 by default, 1000 at most)

Revision as of 12:42, 2 February 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.

READ API Documentation

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.

Searching for products

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.

Example: (remember to do tests on .net) 

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

Combining Tags to get custom results

Combining tags works, letting you create thousands of APIs

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

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

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: (remember to do tests on .net) 

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

Posting a new product

  • Product post to http://world.openfoodfacts.org/cgi/product_jqm2.pl (remember to do tests on .net)
    • var foodfact = { barcode : '3073780969000', name : 'KIRI GOUTER 280G 8 PORTIONS', energy: 500, energy_unit: "kJ", weight: 282 };
    • var postData = {
    • code : foodfact.barcode,
    • user_id : "mesinfosnutritionelles",
    • password : "****",
    • product_name : foodfact.name?foodfact.name:foodfact.shop_label,
    • quantity : foodfact.weight?""+foodfact.weight+" g":undefined,
    • stores : "Intermarché",
    • nutriment_energy :foodfact.energy,
    • nutriment_energy_unit :foodfact.energy_unit,
    • nutrition_data_per :"serving"
    • {"status_verbose":"fields saved","status":1}


Example: (remember to do tests on .net)

http://world.openfoodfacts.org/cgi/product_jqm2.pl?code=3073780969000&user_id=usernameexample&password=*****&product_name=KIRI%20GOUTER%20280G%208%20PORTIONS&quantity=282%20g&stores=Intermarch%C3%A9&nutriment_energy=500&nutriment_energy_unit=kJ&nutrition_data_per=serving

Roadmap

API/Roadmap

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