Difference between revisions of "Open Food Facts Search API Version 2"

From Open Food Facts wiki
Jump to navigation Jump to search
 
(17 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
== Introduction ==
 
== Introduction ==
  
−
The existing Open Food Facts search API is outdated and hacky (it was built on top of the OFF web site search form and is unnecessarily convoluted) and does not support some of the requirements for the [[Project:Personalized_Search]] (in particular being able to retrieve a given set of products using their barcodes).
+
'''NOTE''': '''We're now extracting search to [[Search-a-licious]], which has an OpenAPI documentation, an Elastic-Search backend and everything you'd expect from a modern search API.'''
  
−
We are thus creating a new Open Food Facts Search API Version 2 that will be simpler but also more powerful.
+
Version 1 of the Open Food Facts search API is outdated and hacky (it was built on top of the OFF web site search form and is unnecessarily convoluted) and does not support some of the requirements for the [[Project:Personalized_Search]] (in particular being able to retrieve a given set of products using their barcodes).
 +
 
 +
We have thus created a new Open Food Facts Search API Version 2 that is simpler but also more powerful.
 +
 
 +
* Version 1 of the API will continue to be supported for the years to come, as there are many apps that are using it.
 +
* Version 2 of the API was launched in production in September 2020. It has not been widely publicized yet as we may change it based on the feedback of the first users.
 +
 
 +
== Examples ==
 +
 
 +
Products from the chocolate category, with both the organic label and the fair trade label:
 +
 
 +
* V1:
 +
** https://world.openfoodfacts.org/cgi/search.pl?action=process&tagtype_0=categories&tag_contains_0=contains&tag_0=chocolates&tagtype_1=labels&tag_contains_1=contains&tag_1=organic&tagtype_2=labels&tag_contains_2=contains&tag_2=fair-trade&json=1 (cannot select the fields returned)
 +
* V2
 +
** https://world.openfoodfacts.org/api/v2/search?categories_tags_en=chocolates&labels_tags_en=organic,fair%20trade&fields=code,product_name (returns only selected fields)
 +
** https://world.openfoodfacts.org/search?categories_tags_en=chocolates&labels_tags_en=organic,fair%20trade (corresponding Web site endpoint)
  
 
== Features ==
 
== Features ==
Line 11: Line 26:
 
=== New /api/v2/search (JSON) and /search (OFF web site) endpoints ===
 
=== New /api/v2/search (JSON) and /search (OFF web site) endpoints ===
  
−
The current search API is a hack on the web site search form and is accessed by adding &json=1 to the /cgi/search.pl web form.
+
V1 of the search API is a hack on the web site search form and is accessed by adding &json=1 to the /cgi/search.pl web form.
  
−
The new search API introduces 2 new endpoints that mimick the product page endpoints (/product/[barcode] for the Web, and /api/v0/product/[barcode] for the API with JSON results):
+
The new search API introduces 2 new endpoints that mimics the product page endpoints (/product/[barcode] for the Web, and /api/v0/product/[barcode] for the API with JSON results):
  
 
* /search will replace /cgi/search.pl as the url of search results
 
* /search will replace /cgi/search.pl as the url of search results
 
* /api/v2/search will return JSON results, with the exact same parameters as the /search endpoint
 
* /api/v2/search will return JSON results, with the exact same parameters as the /search endpoint
 +
 +
=== Selection of the fields returned ===
 +
 +
It is possible to specify which fields are returned for each result:
 +
 +
* [https://world.openfoodfacts.org/api/v2/search?categories_tags=en:meals&fields=code,product_name,brands,attribute_groups fields=code,product_name,brands,attribute_groups]
  
 
=== Simplified parameters specification ===
 
=== Simplified parameters specification ===
  
 
Tags fields are now specified directly:
 
Tags fields are now specified directly:
−
* labels_tags=en:organic
+
* [https://world.openfoodfacts.org/api/v2/search?labels_tags=en:organic&fields=code,product_name,labels_tags labels_tags=en:organic]
−
* labels_tags_fr=bio -> bio is assumed to be in French and thus converted to en:organic
+
* [https://world.openfoodfacts.org/api/v2/search?labels_tags_fr=bio&fields=code,product_name,labels_tags_en labels_tags_fr=bio] -> bio is assumed to be in French and thus converted to en:organic
  
 
For AND queries, use comma separated values:
 
For AND queries, use comma separated values:
  
−
* labels_tags=en:organic,en:fair-trade
+
* [https://world.openfoodfacts.org/api/v2/search?labels_tags=en:organic,en:fair-trade&fields=code,product_name,labels_tags  labels_tags=en:organic,en:fair-trade]
  
 
For negative queries, prefix tag with -
 
For negative queries, prefix tag with -
−
* labels_tags=-en:organic,-en:fair-trade
+
* [https://world.openfoodfacts.org/api/v2/search?labels_tags=en:organic,-en:fair-trade&fields=code,product_name,labels_tags  labels_tags=-en:organic,-en:fair-trade]
  
 
=== OR tags fields queries ===
 
=== OR tags fields queries ===
  
 
For OR queries, use | to separate values
 
For OR queries, use | to separate values
−
* labels_tags=en:organic|en:fair-trade|en:some-other-label
+
* [https://world.openfoodfacts.org/api/v2/search?labels_tags=en:organic|en:fair-trade|en:some-other-label&fields=code,product_name,labels_tags labels_tags=en:organic|en:fair-trade|en:some-other-label]
 +
 
 +
=== Conditions on nutrients ===
 +
 
 +
* Per 100g or per serving
 +
** [https://world.openfoodfacts.org/api/v2/search?categories_tags=en:sodas&energy-kj_100g%3C200&fields=code,product_name,energy-kj_100g energy-kj_100g<200]
 +
** [https://world.openfoodfacts.org/api/v2/search?categories_tags=en:sodas&sugars_serving%3E10g&fields=code,product_name,sugars_serving sugars_serving>10]
 +
* Per the product as sold, or prepared
 +
** [https://world.openfoodfacts.org/api/v2/search?categories_tags=en:sodas&saturated-fat_100g=1&fields=code,product_name,saturated-fat_100g saturated-fat_100g=1] (as sold)
 +
** [https://world.openfoodfacts.org/api/v2/search?categories_tags=en:meals&salt_prepared_serving=1&fields=code,product_name,salt_prepared_serving salt_prepared_serving] (prepared, per serving)
  
 
== Development and deployment ==
 
== Development and deployment ==
  
−
The new Search API V2 will be developed and deployed incrementally, and it will co-exist with the existing Search API V1. V1 of the API will not be deprecated until V2 covers an extensive all needed search features.
+
The new Search API V2 has been developed and deployed incrementally in August and September 2020. The new V2 API co-exists with the existing Search API V1.
 +
 
 +
V1 of the API will be supported for the years to come as many apps are using it.
  
−
=== Tags fields ===
+
=== Related issues ===
  
−
* [https://github.com/openfoodfacts/openfoodfacts-server/issues/4011 New search API - tags fields #4011]
+
* [https://github.com/openfoodfacts/openfoodfacts-server/issues/4011 New search API - tags fields #4011] - done
 +
* [https://github.com/openfoodfacts/openfoodfacts-server/issues/4075 New search API - conditions on nutrients #4075] - done
  
−
=== Nutrients ===
+
=== Related PRs ===
  
−
=== Other fields ===
+
* [https://github.com/openfoodfacts/openfoodfacts-server/pull/4039 New search API + simplified parameter handling]
 +
* [https://github.com/openfoodfacts/openfoodfacts-server/pull/4127 Support conditions on nutrients for new search API]
 +
* [https://github.com/openfoodfacts/openfoodfacts-server/pull/4129 Return only specific nutrients through the API]
 +
* [https://github.com/openfoodfacts/openfoodfacts-server/pull/4133 New Search API features + New Product Attributes]
 +
* [https://github.com/openfoodfacts/openfoodfacts-server/pull/4240 New /search endpoint]
  
−
e.g. product name
+
== See also ==
  
 +
[[Open Food Facts API Version 2]]
  
 
[[Category:Project:Personalized_Search]]
 
[[Category:Project:Personalized_Search]]
 
[[Category:ProductOpener]]
 
[[Category:ProductOpener]]
 +
[[Category:API]]
 +
[[Category:Search]]

Latest revision as of 09:13, 15 August 2024

Open Food Facts Search API Version 2

Introduction

NOTE: We're now extracting search to Search-a-licious, which has an OpenAPI documentation, an Elastic-Search backend and everything you'd expect from a modern search API.

Version 1 of the Open Food Facts search API is outdated and hacky (it was built on top of the OFF web site search form and is unnecessarily convoluted) and does not support some of the requirements for the Project:Personalized_Search (in particular being able to retrieve a given set of products using their barcodes).

We have thus created a new Open Food Facts Search API Version 2 that is simpler but also more powerful.

  • Version 1 of the API will continue to be supported for the years to come, as there are many apps that are using it.
  • Version 2 of the API was launched in production in September 2020. It has not been widely publicized yet as we may change it based on the feedback of the first users.

Examples

Products from the chocolate category, with both the organic label and the fair trade label:

Features

New /api/v2/search (JSON) and /search (OFF web site) endpoints

V1 of the search API is a hack on the web site search form and is accessed by adding &json=1 to the /cgi/search.pl web form.

The new search API introduces 2 new endpoints that mimics the product page endpoints (/product/[barcode] for the Web, and /api/v0/product/[barcode] for the API with JSON results):

  • /search will replace /cgi/search.pl as the url of search results
  • /api/v2/search will return JSON results, with the exact same parameters as the /search endpoint

Selection of the fields returned

It is possible to specify which fields are returned for each result:

Simplified parameters specification

Tags fields are now specified directly:

For AND queries, use comma separated values:

For negative queries, prefix tag with -

OR tags fields queries

For OR queries, use | to separate values

Conditions on nutrients

Development and deployment

The new Search API V2 has been developed and deployed incrementally in August and September 2020. The new V2 API co-exists with the existing Search API V1.

V1 of the API will be supported for the years to come as many apps are using it.

Related issues

Related PRs

See also

Open Food Facts API Version 2

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