diff --git a/lang/obf/br/texts/data.html b/lang/obf/br/texts/data.html index eaf6cf721038..605e76dcd290 100644 --- a/lang/obf/br/texts/data.html +++ b/lang/obf/br/texts/data.html @@ -1,132 +1,179 @@ +

RoadennoĆ¹

-

RoadennoĆ¹

- +

Conditions for reuse

The Open Beauty Facts database is available under the Open Database License.
The individual contents of the database are available under the Database Contents License.
Products images are available under the Creative Commons Attribution ShareAlike licence. They may contain graphical elements subject to copyright or other rights, that may in some cases be reproduced (quotation rights or fair use).

-

Please read Terms and conditions of use and re-use before re-using the data.

+

Please read Terms and conditions of use and re-use before re-using the data.

-

We are very interested in learning what the Open Beauty Facts data is used for. It is not mandatory, but we would very much appreciate it if you tell us about your re-uses so that we can share them with the Open Beauty Facts community.

-

Open Beauty Facts data exports

+

Tell us about your reuse

+

We are very interested in learning what the Open Beauty Facts data is used for. It is not mandatory, but we would very much appreciate it if you tell us about your re-uses so that we can share them with the Open Beauty Facts community. You can also fill this form to get a chance to get your app featured.

-

Database dumps and exports are generated nightly.

+

Open Beauty Facts data exports

-

Information on the different fields for the MongoDB dump and CSV exports is available at https://world.openbeautyfacts.org/data/data-fields.txt

+

Database dumps and exports are generated nightly. The database is very big, so you can find different ways to use the data, depending on the export flavor.

+

Information on the different fields for the MongoDB dump and CSV exports is available at https://world.openbeautyfacts.org/data/data-fields.txt

MongoDB dump

Data for all products is available in a MongoDB database dump.

- +
Liamm
-
https://static.openbeautyfacts.org/data/openbeautyfacts-mongodbdump.tar.gz
+
https://static.openbeautyfacts.org/data/openbeautyfacts-mongodbdump.gz
sha256sum
-
https://static.openbeautyfacts.org/data/sha256sum
+
https://static.openbeautyfacts.org/data/gz-sha256sum
md5sum
-
https://static.openbeautyfacts.org/data/md5sum
+
https://static.openbeautyfacts.org/data/gz-md5sum

Delta Export

-

Daily delta exports are provided for the previous 14 days. The list of currently available delta files can be found at - https://static.openbeautyfacts.org/data/delta/index.txt. - Each line represents a file that is available at https://static.openbeautyfacts.org/data/delta/{filename}. - The filename contains UNIX timestamp of the first and the last change contained in the JSON file, so that the delta files can - be imported (after extraction) with mongoimport in alphabetical order.

-

Please note that due to the nature of mongoexport, the delta files cannot tell you about deleted products. Please note that due to the nature of mongoexport, the delta files cannot tell you about deleted products.

- -

CSV Data Export

+

Daily delta exports are provided for the previous 14 days. The list of currently available delta files can be found at https://static.openbeautyfacts.org/data/delta/index.txt.

+

Each line represents a file that is available at https://static.openbeautyfacts.org/data/delta/{filename}.

+

The filename contains UNIX timestamp of the first and the last change contained in the JSON file, so that the delta files can be imported (after extraction) with mongoimport in alphabetical order.

+

Please note that due to the nature of mongoexport, the delta files cannot tell you about deleted products. To remove deleted products from your database, you will need to import the full MongoDB dump.

+ +

JSONL data export

+ +

The whole database is also available in JSONL format (sometimes called LDJSON or NDJSON) where each line is a JSON object. It represents the same data as the MongoDB export. The file is compressed with gzip.

-

Data for all products, or some of the products, can be downloaded in CSV format (readable with OpenOffice, Excel and many other software) - through the advanced search form.

-
Liamm
-
https://static.openbeautyfacts.org/data/en.openbeautyfacts.org.products.csv
+
https://static.openbeautyfacts.org/data/openbeautyfacts-products.jsonl.gz +
-

The file encoding is Unicode UTF-8. The character that separates fields is <tab> (tabulation).

+

A suitable way to exploit the database is to use DuckDB, an in-process analytical tool designed to process large amount of data in a fraction of seconds. You can read our blog post where we walk you through exploring and processing the Open Beauty Facts database with DuckDB

+ +

CSV Data Export

+

Data for all products, or some of the products, can be downloaded in the CSV format (readable with LibreOffice, Excel and many other spreadsheet software) through the advanced search form.

+
+
Links
+
https://static.openbeautyfacts.org/data/en.openbeautyfacts.org.products.csv.gz (compressed CSV in GZIP format: ~ 0.9 Gb, uncompressed: ~ 9 Gb)
+
+

The file encoding is Unicode UTF-8. The character that separates fields is <tab> (tabulation).

RDF Data Export

- -

The database is also available in the RDF format. announcement in French.

+

The database is also available in the RDF format. You can read the announcement in French.

Liamm
-
https://world.openbeautyfacts.org/data/en.openbeautyfacts.org.products.rdf
+
https://world.openbeautyfacts.org/data/en.openbeautyfacts.org.products.rdf.gz
-

Live JSON API

+

Image Data Export

+

All images and OCR results can either be downloaded from our server or from AWS (through the AWS Open Data Program). Check out our documentation to learn more about how to download images.

-The API behaves 99% like Open Food Facts, so many of the SDKs, codes to interact with the Open Food Facts API should work by merely changing the endpoint from: openfoodfacts.org to openbeautyfacts.org. The code hasn't been updated in over a year, so many of the newer APIs like Knowledge Panels are not available yet. -

A JSON API is also available to read the data for a product. This API is in particular used in the Open Beauty Facts mobile app for iPhone and Android.

-

We change the API over-time but we are careful to keep backwards compatibility. Please tell us if you use it, so that we can tell you about potential changes.

+

OpenAPI Documentation for the JSON API

-

URL to read data for a product: https://world.openbeautyfacts.org/api/v2/product/[barcode].json

+

A JSON API is also available to read the data for a product. This API is in particular used in the Open Beauty Facts mobile app for iPhone and Android.

+ +

We improve the API over-time but we are careful to keep backwards compatibility. Please get in touch if you use it, so that we can tell you about potential changes.

+

URL to read data for a product: https://world.openbeautyfacts.org/api/v2/product/[barcode].json

+

Example: https://world.openbeautyfacts.org/api/v3/product/737628064502.json

+

Note that if the output is too overwhelming, you can filter it - as described in the API documentation.

-

Example: https://world.openbeautyfacts.org/api/v2/product/3600550578041.json

+

OpenAPI help wanted

+We're eager to finish the documentation of the API, add use-cases, and automate SDK generation. If you are an OpenAPI connoisseur, you are very welcome to help. + +

You are very welcome to use the API for production cases, as long as 1 API call = 1 real scan by a user. Any attempt to scrape the database using the API will very likely be blocked, as full daily exports are available on this very page.

Also, sending an HTTP header with your API call is a good way we can get in touch, should any issue arise.

-

If you are unsure about anything, or have any question (there is no silly question), feel free to ask it on Slack :-)

+

If you are unsure about anything, or have any question (there is no silly question), feel free to ask it on the #api channel on Slack :-)

-

Android and iPhone mobile app (help needed!)

+

Experimental XML API

+

You can also get the result in XML by using .xml

+

Example: https://world.openbeautyfacts.org/api/v2/product/737628064502.xml

+This API is not actively maintained, and not officially documented. -

The code for the Open Beauty Facts mobile app is available on GitHub (Android and iOS). We need help to adapt the new native iOS code to cosmetics -The app allows users to scan the barcode of products, to view the product information, and to take and send pictures and data for missing products.

-

The app for Android is developed in Kotlin.

-

The new cross-platform app is developed in Flutter/Dart.

-

You are welcome to reuse the code (it's open source) and help us improve it, for everyone, on all the planet. - -

Wrappers and SDKs

-

We probably have a wrapper for your favorite programming language. If we do, you can use it and improve it, and probably add Open Beauty Facts support to it. If we don't, you can help create it.

+

Wrappers and SDKs

+

We probably have a wrapper for your favorite programming language. If we do, you can use it and improve it. If we don't, you can help create it.

They will let you consume data, as well as let your users contribute new data

+ +

General principles to make your users happy

-

Discussing data, API and exports

-

You can join the Open Beauty Facts Slack chatroom which is the preferred way to ask questions and discuss the API.

-

You can open a thread on our API documentation repository - +

If your users do not expect a result immediately (e.g. Inventory apps)

+ + +

If your users expect a result immediately (e.g. Allergy apps)

+ + +

Android/iPhone/Flutter mobile app

+ +

The code for the Open Beauty Facts mobile app is available on GitHub (Flutter, Kotlin Android and Swift iOS). -

Darempred

+

We look to turn the deprecated Kotlin and Swift codebases into Kotlin and Swift SDKs, help welcome :-)

+

The app allows users to scan the barcode of products, to view the product information, and to take and submit pictures and data for missing products.

-

For any question regarding the data, you can contact us at contact@openfoodfacts.org +

You are welcome to reuse the code (it's open source) and help us improve it, for everyone, on all the planet.

+ +

SDKs

+ + + + +

Discussing data, API and exports

+ +

You can look at common FAQ questions about the API and Data Exports and common Open Food Facts questions

+

You can join the Open Beauty Facts Slack chatroom which is the preferred way to ask questions and discuss the API. Please ask your questions in the #api channel

+

You can open a thread on our API documentation repository +

For any question regarding the data, you can contact us at reuse@openfoodfacts.org