x-one/gus-bundle

There is no license information available for the latest version (v0.1.0) of this package.

Integrates GUS API Client with Symfony SWP projects

v0.1.0 2024-03-13 11:17 UTC

Requires

• php: >=8.2
• ext-simplexml: *
• ext-soap: *
• gusapi/gusapi: 6.1.1
• symfony/framework-bundle: 6.4.*
• symfony/translation: 6.4.*

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.13
• mtdowling/jmespath.php: ^2.6
• phpstan/phpstan: ^1.10
• symfony/phpunit-bridge: ^6.3
• zenstruck/browser: ^1.4
• zenstruck/foundry: ^1.34

Unknown License

• gus-bundle

README

1. Instalacja

Dodaj do swojego dockerfile i przebuduj kontener:

docker-php-ext-install soap
docker-php-ext-install simplexml

W kontenerze uruchom:

composer require xone/gus-bundle

Dodaj do pliku .env:

GUS_TOKEN=klucz_api

Klucz produkcyjny można uzyskać składając wniosek na https://api.stat.gov.pl/Home/RegonApi Klucz testowy dostępny w passbolcie (gustoken)

Dodaj plik konfiguracyjny:

# config/routes/x_one_gus.yaml
x_one_gus:
  resource: "@XOneGusBundle/config/routes.yaml"

1. Użycie

Został wystawiony endpoint /gus/search, który przyjmuje parametr NIP. W odpowiedzi zwraca dane firmy z GUS.

W przypadku użycia w innej klasie:

use XOne\Bundle\GusBundle\Service\GusApiService;

class YourService
{
    public function __construct(protected GusApiService $gusApiService)
    {}

    public function getCompanyData(string $nip)
    {
        $companyData = $this->gusApiService->search($nip);
    }
}

W GusApiService numer NIP jest walidowany, jeśli nie jest poprawny zostanie rzucony wyjątek.