mmierzynski/gus-api-bundle

Symfony bundle that allows to search data in GUS database

0.2 2022-10-29 13:38 UTC

Requires

• php: >=7.1
• ext-json: *
• ext-simplexml: *
• ext-soap: *
• symfony/framework-bundle: ^6.0
• symfony/serializer: ^6.0
• symfony/validator: ^6.1

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.12
• phpmd/phpmd: ^2.13
• phpunit/phpunit: ^7.0 | ^8.0 | ^9.0

MIT

• Mateusz Mierzyński

README

Description

Symfony 6 Bundle that allows to get information from REGON GUS API

Installation

composer require mmierzynski/gus-api-bundle

Usage

Configuration

# config/packages/gus_api.yaml

gus_api:
  regon:
    env: test
    api_key: 'abcde12345abcde12345'

• env - [Required] GUS API environment. Accepted values: test, prod
• api_key - [Required] Your API key. For test env you can use: abcde12345abcde12345

Usage

Login user

use MMierzynski\GusApi\Client\RegonApiClient;
use MMierzynski\GusApi\Exception\InvalidUserCredentialsException;

public function index(RegonApiClient $client): JsonResponse
{
    if (!$client->isUserLogged()){
        try{
            $accessKey = $client->login();
        } catch (InvalidUserCredentialsException $credentialsException) {
            // do something
        }
    }

    ...
}

Search for company

use MMierzynski\GusApi\Client\RegonApiClient;
use MMierzynski\GusApi\Model\DTO\Request\SearchCompanyParams;

public function index(RegonApiClient $client): JsonResponse
{
    ...
    $searchParams = new SearchCompanyParams(Nip:'8992689516');
    $company = $client->searchForCompany($accessKey, $searchParams);
    ...
}

Get full report

use MMierzynski\GusApi\Client\RegonApiClient;

public function index(RegonApiClient $client): JsonResponse
{
    ...
    $fullReport = $client->getFullReport(
        $accessKey, 
        '000331501', 
        'BIR11OsPrawna'
    );
    ...
}

Get summary report

use MMierzynski\GusApi\Client\RegonApiClient;

public function index(RegonApiClient $client): JsonResponse
{
    ...
    $reportDate = (new DateTimeImmutable())->setDate(2014, 11, 7);
    $summaryReport = $client->getSummaryReport(
        $accessKey, 
        'BIR11NowePodmiotyPrawneOrazDzialalnosciOsFizycznych', 
        $reportDate
    );
    ...
}