elegantly / laravel-pappers
pappers.fr API for Laravel
Fund package maintenance!
Elegantly
Requires
- php: ^8.2
- illuminate/contracts: ^10.0||^11.0
- saloonphp/cache-plugin: ^3.0
- saloonphp/laravel-plugin: ^3.5
- saloonphp/rate-limit-plugin: ^2.0
- saloonphp/saloon: ^3.0
- spatie/laravel-package-tools: ^1.16
Requires (Dev)
- larastan/larastan: ^2.9
- laravel/pint: ^1.14
- nunomaduro/collision: ^8.1.1||^7.10.0
- orchestra/testbench: ^9.0.0||^8.22.0
- pestphp/pest: ^2.34
- pestphp/pest-plugin-arch: ^2.7
- pestphp/pest-plugin-laravel: ^2.3
- phpstan/extension-installer: ^1.3
- phpstan/phpstan-deprecation-rules: ^1.1
- phpstan/phpstan-phpunit: ^1.3
README
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_DRIVER', 'file')), 'expiry_seconds' => 604_800, // 1 week ], 'rate_limit' => [ 'enabled' => false, 'driver' => env('PAPPERS_RATE_LIMIT_DRIVER', 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
License
The MIT License (MIT). Please see License File for more information.