Skip to content

Commit

Permalink
docs: Create scanning-cosmetics.md (#10268)
Browse files Browse the repository at this point in the history
* 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
teolemon authored and john-gom committed May 24, 2024
1 parent 2c89e0b commit de0bfdb
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 2 deletions.
7 changes: 5 additions & 2 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ WikiData:
- any-glob-to-any-file: 'scripts/gen_feeds_daily_opff.sh'
- any-glob-to-any-file: 'lib/ProductOpener/Config_opff.pm'
- any-glob-to-any-file: 'conf/nginx/snippets/ssl-params-opff.conf'
- any-glob-to-any-file: 'docs/reference/api-tutorials/scanning-cosmetics-pet-food-and-other-products.md'

# Our cosmetic analysis project https://world.openbeautyfacts.org
# Open Beauty Facts is a specialized install of Product Opener. The deployed version is a very old codebase, 2 years old.
Expand Down Expand Up @@ -158,7 +159,8 @@ WikiData:
- any-glob-to-any-file: 'taxonomies/beauty/inci_functions.result.sto'
- any-glob-to-any-file: 'tests/unit/expected_test_results/import_gs1/equadis_unilever_obf_signal.off.json'
- any-glob-to-any-file: 'tests/unit/expected_test_results/import_gs1/equadis_unilever_obf_signal.json'

- any-glob-to-any-file: 'docs/reference/api-tutorials/scanning-cosmetics-pet-food-and-other-products.md'

# Open Products Facts is our platform for other platform. We plan to turn it into the data platform to facilitate circular behaviors (buy, maintain, repare, donate, resale)
# Open Products Facts is a specialized install of Product Opener that tackles all products OFF, OBF or OPFF are not tackling.
# http://world.openproductsfacts.org/
Expand All @@ -178,7 +180,8 @@ WikiData:
- any-glob-to-any-file: 'scripts/gen_feeds_daily_opf.sh'
- any-glob-to-any-file: 'lib/ProductOpener/Config_opf.pm'
- any-glob-to-any-file: 'taxonomies/products/unspsc.txt'

- any-glob-to-any-file: 'docs/reference/api-tutorials/scanning-cosmetics-pet-food-and-other-products.md'

Icons:
- changed-files:
- any-glob-to-any-file: 'icons/**/*'
Expand Down
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]

0 comments on commit de0bfdb

Please sign in to comment.