-
-
Notifications
You must be signed in to change notification settings - Fork 359
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Create scanning-cosmetics.md (#10268)
* docs: Create scanning-cosmetics.md * Update scanning-cosmetics.md * Update scanning-cosmetics.md * Update scanning-cosmetics.md * Update scanning-cosmetics.md * Update and rename scanning-cosmetics.md to scanning-cosmetics-pet-food-and-other-products.md * Update scanning-cosmetics-pet-food-and-other-products.md * Update scanning-cosmetics-pet-food-and-other-products.md * Update labeler.yml
- Loading branch information
Showing
2 changed files
with
57 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
52 changes: 52 additions & 0 deletions
52
docs/reference/api-tutorials/scanning-cosmetics-pet-food-and-other-products.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
### Open Beauty Facts, Open Pet Food Facts, Open Products Facts experimental and specific APIs | ||
|
||
* Open Beauty Facts, Open Pet Food Facts, Open Products Facts behave mostly like Open Food Facts. Behaviours may change over time, as we tweak it. | ||
|
||
#### Specific base URLs | ||
* Cosmetics: The base URL is openbeautyfacts.org instead of openfoodfacts.org | ||
* Pet Food: The base URL is openpetfoodfacts.org instead of openfoodfacts.org | ||
* Other type of products: The base URL is openproductsfacts.org instead of openfoodfacts.org | ||
|
||
#### Different behaviours common to Open Beauty Facts, Open Pet Food Facts, Open Products Facts | ||
* Old codebase, being upgraded very soon: Knowledge panels are not supported, the new packaging API is not supported | ||
* Search-a-licious, Open Prices, Folksonomy Engine, Nutri-Patrol not supported yet | ||
* No Robotoff questions yet | ||
|
||
#### Specificities of Open Beauty Facts | ||
* No nutrition table | ||
* No Eco-Score, Nutri-Score or NOVA level for ultra-processing | ||
|
||
#### Specificities of Open Pet Food Facts | ||
* No Eco-Score, Nutri-Score or NOVA level for ultra-processing | ||
|
||
#### Specificities of Open Products Facts | ||
* No nutrition table | ||
* No Eco-Score, Nutri-Score or NOVA level for ultra-processing | ||
* Most data will be modelled using the [Folksonomy Engine](docs/reference/api-tutorials/folksonomy-engine.md) | ||
|
||
### API Roadmap and multi-project behaviour | ||
* We plan to bring the APIs mentionned above to Open Beauty Facts (Search-a-licious, Knowledge Panels, Open Prices, Robotoff, Folksonomy Engine) | ||
* We plan to have a universal barcode scanning API, where you scan a barcode, and you get a result from either Open Food Facts, Open Pet Food Facts, Open Beauty Facts or Open Products Facts | ||
* If no result is found in any of the 4 databases, you will have to ask the type of product to your users, and use the classic product addition API on the right project. | ||
* If (it can happen) the product appears on the wrong project, we suggest you use the NutriPatrol API to let your users report it to the moderators, and the proceed to a product addition on the right project. The moderators will then move the existing data to the right project. Eventually, project categorization errors should be infinitesimal. | ||
|
||
### Sample outputs | ||
* Please use the Open Food Facts API reference for most operations (data and photo addition, ingredient lists, categories, labels…) | ||
|
||
#### Product in Open Beauty Facts | ||
* https://world.openbeautyfacts.org/api/v2/product/3560070791460.json | ||
|
||
#### Ingredients | ||
*Very experimental. Do not rely on this for allergen or ingredient parsing yet.* | ||
##### List of ingredients detected by the current experimental parser | ||
* https://world.openbeautyfacts.org/ingredients.json | ||
|
||
##### Products where the current experimental parser could not detect aluminium salts | ||
* https://world.openbeautyfacts.org/ingredient/-aluminum-salts.json | ||
|
||
##### Products where the current experimental parser could detect aluminium salts | ||
* https://world.openbeautyfacts.org/ingredient/aluminum-salts.json | ||
|
||
#### Periods after Opening | ||
[https://en.wiki.openbeautyfacts.org/Global_period_after_opening_taxonomy Periods after opening taxonomy] | ||
|