README.md

pappers.fr API for Laravel

Easily use pappers.fr Entreprises API within Laravel.

Based on Saloon and supporting cache and rate limiting.

Installation

You can install the package via composer:

composer require elegantly/laravel-pappers

You can publish the config file with:

php artisan vendor:publish --tag="pappers-config"

This is the contents of the published config file:

return [

    'france' => [
        'token' => env('PAPPERS_FRANCE_TOKEN', env('PAPPERS_TOKEN')),
        'version' => env('PAPPERS_FRANCE_VERSION'),
    ],

    'international' => [
        'token' => env('PAPPERS_INTERNATIONAL_TOKEN', env('PAPPERS_TOKEN')),
        'version' => env('PAPPERS_INTERNATIONAL_VERSION'),
    ],

    'cache' => [
        'enabled' => true,
        'driver' => env('PAPPERS_CACHE_DRIVER', env('CACHE_STORE', env('CACHE_DRIVER', 'file'))),
        'expiry_seconds' => 604_800, // 1 week
    ],

    'rate_limit' => [
        'enabled' => false,
        'driver' => env('PAPPERS_RATE_LIMIT_DRIVER', env('CACHE_STORE', env('CACHE_DRIVER', 'file'))),
        'every_minute' => 30,
    ],
];

Usage

use Elegantly\Pappers\Facades\Pappers;
use Elegantly\Pappers\Integrations\France\Requests\EntrepriseRequest;

$entreprise = Pappers::france()->send(new EntrepriseRequest(
    siren: "897962361"
));

use Elegantly\Pappers\Facades\Pappers;
use Elegantly\Pappers\Integrations\International\Requests\CompanyRequest;

$entreprise = Pappers::international()->send(new CompanyRequest(
    country_code: "FR",
    company_number: "897962361"
));

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Quentin Gabriele
• All Contributors

License

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