PHP GUS API is an object-oriented library to get information from REGON site based on official REGON SOAP API. Official GUS docs here.
This library uses Composer, just type in:
composer require gusapi/gusapi| Version | PHP version | BIR service version | Support | Doc |
|---|---|---|---|---|
| 6.x | >= 8.0 | BIR1.1 (available since October 2022) | Support ends on April 1, 2023 | Doc |
| 5.x | >= 7.1 | BIR1.1 (available since May 2019) | Support ends on December 1, 2020 | Doc |
If you still use PHP <= 8.0 see documentation for 5.x version HERE
For more information see UPGRADE.md.
See file examples/readmeExample.php.
require_once '../vendor/autoload.php';
use GusApi\Exception\InvalidUserKeyException;
use GusApi\Exception\NotFoundException;
use GusApi\GusApi;
use GusApi\ReportTypes;
use GusApi\BulkReportTypes;
$gus = new GusApi('your api key here');
//for development server use:
//$gus = new GusApi('abcde12345abcde12345', 'dev');
try {
$nipToCheck = 'xxxxxxxxxx'; //change to valid nip value
$gus->login();
$gusReports = $gus->getByNip($nipToCheck);
var_dump($gus->dataStatus());
var_dump($gus->getBulkReport(
new DateTimeImmutable('2019-05-31'),
BulkReportTypes::REPORT_DELETED_LOCAL_UNITS
));
foreach ($gusReports as $gusReport) {
//you can change report type to other one
$reportType = ReportTypes::REPORT_PERSON;
echo $gusReport->getName();
echo 'Address: ' . $gusReport->getStreet() . ' ' . $gusReport->getPropertyNumber() . '/' . $gusReport->getApartmentNumber();
$fullReport = $gus->getFullReport($gusReport, $reportType);
var_dump($fullReport);
}
} catch (InvalidUserKeyException $e) {
echo 'Bad user key';
} catch (NotFoundException $e) {
echo 'No data found <br>';
echo 'For more information read server message below: <br>';
echo sprintf(
"StatusSesji:%s\nKomunikatKod:%s\nKomunikatTresc:%s\n",
$gus->getSessionStatus(),
$gus->getMessageCode(),
$gus->getMessage()
);
}