mrcnpdlk/regon-api

GUS Regon API

2.0.0 2020-03-21 21:34 UTC

Requires

• php: >=7.2
• ext-dom: *
• ext-json: *
• ext-simplexml: *
• ext-soap: *
• gregwar/cache: ^1
• laminas/laminas-json: ^3
• mrcnpdlk/lib-configuration: ^0
• mrcnpdlk/lib-exception: ^0
• mrcnpdlk/lib-mapper: ^0
• myclabs/php-enum: ^1
• psr/log: ^1
• psr/simple-cache: ^1

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2
• jangregor/phpstan-prophecy: ^0
• monolog/monolog: ^1
• phpstan/phpstan: ^0
• phpstan/phpstan-phpunit: ^0
• phpunit/php-code-coverage: ^7
• phpunit/phpunit: ^8

MIT

• Marcin Pudełek

• soap
• regon
• nip
• GUS
• krs

README

REGON API - Polish companies database v2

Installation

Install the latest version with composer

composer require mrcnpdlk/regon-api

API uses BIR 1.1

Basic usage

Configuration

Available options:

Creating instance

$oConfig = new Mrcnpdlk\Api\Regon\Config([
    'password' => 'my_password',
]);

$oNativeApi = new \Mrcnpdlk\Api\Regon\NativeApi($oConfig);
$oApi = new \Mrcnpdlk\Api\Regon\Api($oConfig);

NativeApi

NativeApi class implements native GUS methods such like:

• Zaloguj()
• Wyloguj()
• GetValue(ValueEnum $param)
• DaneSzukajPodmioty( string $regon = null, string $nip = null, string $krs = null, array $tRegon = [], array $tNip = [], array $tKrs = [])
• DanePobierzRaportZbiorczy(string $date, ReportCompactEnum $report)
• DanePobierzPelnyRaport(string $regon, ReportFullEnum $report)

Api

Api class implements usable methods based on NativeApi class.

• searchByNip()
• searchByKrs()
• searchByRegon()
• getPKD()
• getReport()