Skip to content
PHP GUS API library based on official REGON SOAP api.
PHP
Branch: master
Clone or download
Latest commit bc6da0b Dec 3, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples Upgrade BRI version to 1.1 - add all needed changes. Jun 2, 2019
src/GusApi use root namespace, PHP 7.4 tests Dec 3, 2019
tests use root namespace, PHP 7.4 tests Dec 3, 2019
.gitignore allow PHPUnit 8 Dec 2, 2019
.php_cs.dist use root namespace, PHP 7.4 tests Dec 3, 2019
.styleci.yml
.travis.yml use root namespace, PHP 7.4 tests Dec 3, 2019
LICENSE
README.md use root namespace, PHP 7.4 tests Dec 3, 2019
UPGRADE.md
composer.json allow PHPUnit 8 Dec 2, 2019
phpcs.xml.dist Add php cs Apr 18, 2018
phpstan.neon use root namespace, PHP 7.4 tests Dec 3, 2019
phpunit.xml.dist PHP 7.1 support Apr 17, 2018

README.md

PHP GUS API library

Packagist Build Status Codecov Packagist Packagist StyleCI Scrutinizer Code Quality

PHP GUS API is an object-oriented library to get information from REGON site based on official REGON SOAP API. Official GUS docs here.

Installation

This library uses Composer, just type in:

composer require gusapi/gusapi

Supported Versions

Version PHP version BIR service version Support Doc
5.x >= 7.1 BIR1.1 (available since May 2019) Support ends on December 1, 2020 Doc
4.x >= 7.1 BIR1 Support ends on December 1, 2019 Doc
3.3.x >= 5.6 BIR1 Support ends on December 1, 2018 Doc
3.2.x >= 5.4 BIR1 Support ended on April 1, 2018 Doc

If you still use PHP <= 7.0 see documentation for 3.3.x version HERE

New in 5.x (this version support BIR1.1)

  • New properties in SearchReport:

    • nip

    • nipStatus

    • propertyNumber

    • apartmentNumber

    • activityEndDate

      Till version 5.x you dont need to get full report to find property number and apartment number

  • Method getFullReport throws InvalidReportTypeException for invalid report name

  • Method dataStatus now return DateTimeImmutable instead of DateTime and throws InvalidServerResponseException

  • New method getBulkReport - new search type in BIR1.1 (mode documentation here) with BulkReportTypes

  • New supported report types for getBulkReport method (based on BIR1.1 documentation):

    public const REPORT_NEW_LEGAL_ENTITY_AND_NATURAL_PERSON = 'BIR11NowePodmiotyPrawneOrazDzialalnosciOsFizycznych';
    public const REPORT_UPDATED_LEGAL_ENTITY_AND_NATURAL_PERSON = 'BIR11AktualizowanePodmiotyPrawneOrazDzialalnosciOsFizycznych';
    public const REPORT_DELETED_LEGAL_ENTITY_AND_NATURAL_PERSON = 'BIR11SkreslonePodmiotyPrawneOrazDzialalnosciOsFizycznych';
    public const REPORT_NEW_LOCAL_UNITS = 'BIR11NoweJednostkiLokalne';
    public const REPORT_UPDATED_LOCAL_UNITS = 'BIR11AktualizowaneJednostkiLokalne';
    public const REPORT_DELETED_LOCAL_UNITS = 'BIR11SkresloneJednostkiLokalne';
  • Remove ReportTypeMapper

Upgrade from 4.x to 5.x

For more information see UPGRADE.md.

Example for 5.x

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_ACTIVITY_PHYSIC_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 $gus->getResultSearchMessage();
}

Donation

If this project help you reduce time to develop, you can give me a cup of coffee ;)
PayPal Donate

You can’t perform that action at this time.