965
edits
Changes
Jump to navigation
Jump to search
Line 3:
Line 3: + − + − + − + − +
+ 1 API call = 1 real scan by a user
== Introduction ==
== Introduction ==
=== Notice for API users ===
=== Notice for API users ===
# You are very welcome to use the API for production cases, as long as 1 API call = 1 real scan by a user.
# <span style="color:#d33">'''If you need all the database, download it directly from the data page, do ''NOT'' scrape the API'''</span>
# <span style="color:#d33">'''If you need all the database, download it directly from the data page, do ''NOT'' scrape the API'''</span>
# Please tell us (contact@openfoodfacts.org or in the #API channel) what you build with the API, it's always great to see new reuses come to life :-)
# Please tell us (contact@openfoodfacts.org or in the #API channel) what you build with the API, it's always great to see new reuses come to life :-)
=== Before using the API ===
=== Before using the API ===
* Some products are incomplete.
* Some products are incomplete.
* '''You should ensure your UX tells the final user that the product is not complete, encourage them to exercise caution and/or help complete the product.'''
* '''You should ensure your UX tells the final user that the product is not complete, encourage them to exercise caution and/or help complete the product.'''
* When doing averages, computations… filter incomplete products to avoid issues
* When doing averages, computations... filter incomplete products to avoid issues.
* Assume the data is not reliable until the product is marked as complete.
* Assume the data is not reliable until the product is marked as complete.
* '''In general, ensure the user exercises caution (for allergens…) and be upfront about possible risks.'''
* '''In general, ensure the user exercises caution (for allergens...) and be upfront about possible risks.'''
* <span style="color:#d33">'''By using any part of the API you have read and understood the [[#License|license]].'''</span>
* <span style="color:#d33">'''By using any part of the API you have read and understood the [[#License|license]].'''</span>
=== Current status of the API ===
=== Current status of the API ===
Currently the API is used internally for the official Open Food Facts mobile applications (iOS, Android, Windows, and we need help!) and by hundreds of reuses on various topics (Nutrition, sport…) and platforms (iOS, Android…), but does not yet follow good practices in API design.
Currently, the API is used internally for the official Open Food Facts mobile applications (iOS, Android, Windows, and we need help!) and by hundreds of reuses on various topics (Nutrition, sport…) and platforms (iOS, Android...), but does not yet follow good practices in API design.
It is also used by several applications and while not yet stable, doesn't change much.
It is also used by several applications and while not yet stable, doesn't change much.