README

BIR1.1（REGON v1.1 网络数据库）API (https://wyszukiwarkaregon.stat.gov.pl/appBIR/index.aspx).

安装

可以通过Composer安装API客户端。

在你的composer.json文件中

{
    "require": {
        "sj_royd/regon_api": "~1.0"
    }
}

或者使用命令行

composer require sj_royd/regon_api

基本用法

默认日期格式

默认数据日期格式为yyyy-mm-dd。可以更改日期格式

<?php

require_once 'vendor/autoload.php';

use \SJRoyd\GUS\RegonApi\Date;

Date::setFormat('d.m.Y'); // format dd.mm.yyyy

登录

测试模式

<?php

require_once 'vendor/autoload.php';

use SJRoyd\GUS\RegonApi\Exception\KeyMissingException;
use SJRoyd\GUS\RegonApi\BIRService;

$userKey = null; // In the test mode any key is accepted

$api = new BIRService(true);
try {
    $api->login($userKey);
} catch (KeyMissingException $e) {
}

生产模式

<?php

require_once 'vendor/autoload.php';

use SJRoyd\GUS\RegonApi\BIRService;

$userKey = 'my-unique-key'; // User key obtained from the GUS

$api = new BIRService();
$api->login($userKey);

搜索单位

<?php

use SJRoyd\GUS\RegonApi\Enum\SearchType;
use SJRoyd\GUS\RegonApi\Exception\InvalidSearchTypeException;
use SJRoyd\GUS\RegonApi\Exception\NotFoundException;
use SJRoyd\GUS\RegonApi\Exception\NumberMissingException;
use SJRoyd\GUS\RegonApi\Exception\TooManyNumbersException;

try {
    $searchBy = SearchType::NIP;
    $searchNumber = '5261040828'
    $units = $api->search($searchBy, $searchNumber);
} catch (InvalidSearchTypeException $e) {
} catch (NotFoundException $e) {
} catch (NumberMissingException $e) {
} catch (TooManyNumbersException $e) {
}

搜索类型

• SearchType::NIP参数为字符串
• SearchType::NIPS参数为数组字符串或以新行、空格、点、逗号或分号分隔的字符串
• SearchType::REGON参数为字符串
• SearchType::REGONS参数为数组字符串或字符串(...)
• SearchType::KRS参数为字符串
• SearchType::KRSES参数为数组字符串或字符串(...)
• SearchType::REGONS9参数为数组字符串或字符串(...)
• SearchType::REGONS14参数为数组字符串或字符串(...)

报告

<?php

use SJRoyd\GUS\RegonApi\Enum\ReportType;
use SJRoyd\GUS\RegonApi\Exception\CivilLawPartnershipException;
use SJRoyd\GUS\RegonApi\Exception\NotFoundException;
use SJRoyd\GUS\RegonApi\Exception\PkdException;
use SJRoyd\GUS\RegonApi\Exception\ReportException;

$regon = '';
$reportType = ReportType::PHYSIC_GENERAL;
try {
    $api->getFullReport($regon, $reportType);
} catch (CivilLawPartnershipException $e) {
} catch (NotFoundException $e) {
} catch (PkdException $e) {
} catch (ReportException $e) {
}

报告类型列表

注意：并非每个法律单位都是S.C.（民事合伙法）且此报告可能会引发CivilLawPartnershipException。

自动获取特定单位的相关报告

<?php

use SJRoyd\GUS\RegonApi\Exception\NotFoundException;
use SJRoyd\GUS\RegonApi\Exception\PkdException;
use SJRoyd\GUS\RegonApi\Exception\ReportException;

try {
    foreach($units as $unit){
        $unit->getReports();
    }
} catch (NotFoundException $e) {
} catch (PkdException $e) {
} catch (ReportException $e) {
}

每个报告都将保存到单位属性中的reports属性。

GetValue

<?php

use SJRoyd\GUS\RegonApi\Enum\Value;

$value = $api->getValue(Value::SERVICE_STATUS);
$value->getMessage();