README

Laravel Open Food Facts API

This package provides a convenient wrapper to the Open Food Facts API for Laravel applications.

Requirements

• PHP 8.1+
• Laravel 9.x, 10.x, 11.x

Installation

You can install the package via composer:

composer require openfoodfacts/openfoodfacts-laravel

Legacy support

• PHP 8.0 (Laravel <=9.x): composer require "openfoodfacts/openfoodfacts-laravel:^0.3"
• PHP 7.2-7.4.x (Laravel 5.7-8.x): composer require "openfoodfacts/openfoodfacts-laravel:^0.2"

Usage

Find product details by barcode

OpenFoodFacts::barcode('20203467');

it returns an array with product details:

Array
(
    [product_name] => Cantuccini with hazelnuts
    [image_url] => https://static.openfoodfacts.org/images/products/20203467/front_fr.4.400.jpg
    ...    
)    

... or find in other product databases:

$beauty = OpenBeautyFacts::barcode('8718951087460');

$pet = OpenPetFoodFacts::barcode('8714265000263'); // Note: underlying product database is under construction

Find products that match a search term:

$collection = OpenFoodFacts::find('Coca Cola Zero');

// returns a Illuminate\Support\Collection of arrays with details of each product found

Also works with:

$pet = OpenPetFoodFacts::find('Yarrah');
$beauty = OpenBeautyFacts::find("Deodorant Alum");

Contributing

You're very welcome to contribute. We coordinate on the Open Food Facts slack, on the #PHP channel : https://slack.openfoodfacts.org Please see CONTRIBUTING for details.

License

The MIT License (MIT). Please see License File for more information.

Using this SDK and Third party applications

• If you use this SDK, feel free to open a PR to add your application in the list in REUSERS.md
• Make sure you comply with the OdBL licence, mentioning the Source of your data, and ensuring to avoid combining non free data you can't release legally as open data. Another requirement is contributing back any product you add using this SDK.
• Please get in touch at reuse@openfoodfacts.org
• We are very interested in learning what the Open Food Facts data is used for. It is not mandatory, but we would very much appreciate it if you tell us about your re-uses (https://forms.gle/hwaeqBfs8ywwhbTg8) so that we can share them with the Open Food Facts community. You can also fill this form to get a chance to get your app featured: https://forms.gle/hwaeqBfs8ywwhbTg8

Authors