laravel-bir-regon

← Documentation

Installation

Requirements

Laravel BIR REGON requires:

• PHP 8.3 or newer
• Laravel 12 or 13
• the PHP SOAP extension
• the PHP SimpleXML extension

The test matrix covers Laravel 12 and 13 on PHP 8.3, 8.4, and 8.5. PHP 8.3 is tested with both the lowest and highest supported dependency versions for each Laravel release, while PHP 8.4 and 8.5 use the highest supported versions.

Composer verifies the required PHP extensions through the underlying gusapi/gusapi dependency.

Install the package

Install the package via Composer:

composer require cieplik206/laravel-bir-regon

Laravel’s package discovery registers cieplik206\BirRegon\BirRegonServiceProvider automatically. No changes to bootstrap/providers.php are required.

Configure the API key

Add your production BIR API key to .env:

BIR_API_KEY=your-api-key

The API key is required for searches, reports, the data-status endpoint, and diagnostics. Reading the public service status does not require authentication.

Never commit a real API key to the repository.

The package includes the public key for the official GUS sandbox. If GUS provides a different test key, configure it separately:

BIR_SANDBOX_API_KEY=your-test-key

The sandbox key is never used for production requests, and the production key is never sent to the sandbox endpoint.

Publish the configuration

Publishing is optional. The package defaults work directly from environment variables, but a published file makes the available settings visible in the application:

php artisan vendor:publish --tag=bir-regon-config

This creates config/bir-regon.php.

Laravel Boost skill

The package includes an optional bir-regon-development agent skill. If the consuming application does not yet use Laravel Boost, install and configure it first:

composer require laravel/boost --dev
php artisan boost:install

If Boost was installed before Laravel BIR REGON, discover newly installed package skills with:

php artisan boost:update --discover

Laravel Boost will offer to install the skill for the configured AI agents. The package does not require Laravel Boost at runtime. See Laravel Boost support for the skill’s scope and update workflow.

Manual provider registration

This is only necessary when package discovery is disabled in the consuming application. Add the provider to bootstrap/providers.php:

<?php

use cieplik206\BirRegon\BirRegonServiceProvider;

return [
    App\Providers\AppServiceProvider::class,
    BirRegonServiceProvider::class,
];

Continue with Configuration.

This site is open source. Improve this page.