finller/laravel-insee-siren

Insee Siren API for Laravel

v0.0.4 2024-05-14 09:09 UTC

This package is auto-updated.

Last update: 2024-05-14 09:10:19 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

Simple package to use Insee Siren API in Laravel.

It provides cache, rate limiting and auth.

Installation

You can install the package via composer:

composer require finller/laravel-insee-siren

You can publish and run the migrations with:

php artisan vendor:publish --tag="insee-siren-config"

This is the contents of the published config file:

use Finller\InseeSiren\Integrations\Insee\InseeApiConnector;

return [
    'key' => env('INSEE_KEY'),
    'secret' => env('INSEE_SECRET'),
    'version' => env('INSEE_SIREN_VERSION'),

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

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

    'client' => InseeApiConnector::class,
];

Usage

$data = InseeSiren::get("897962361");

$data->get('uniteLegale')

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.