goosfraba/teryt-sdk

The SDK for GUS TERYT API

Maintainers

Details

github.com/dbojdo/teryt-sdk

Source

Issues

Installs: 2 631

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 1

Open Issues: 0

1.0.0 2023-04-13 09:22 UTC

Requires

Requires (Dev)

MIT b2b15f375a57227c846ab459a0873b631f7eaac2

terytGUSTERCSIMCulic

This package is auto-updated.

Last update: 2024-10-16 23:09:10 UTC

README

The library provides a wrapper for GUS TERYT SOAP API.

Installation

Recommended way of installation is via composer

composer require goosfraba/teryt-sdk

Usage

Create an instance of the API:

use Goosfraba\Teryt\Soap\TerytApiFactory;
use Goosfraba\Teryt\Soap\Dsn;

$factory = new TerytApiFactory();

$dsn = Dsn::prod("your-user", "your-pass");
// or 
$dsn = Dsn::test(); // public test credentials
// or
$dsn = Dsn::parse("gus+teryt://your-user:your-pass@prod"); // your production credentials

$api = $factory->create($dsn);

Use API according to their documentation:

use Goosfraba\Teryt\TerytApi;

/** @var TerytApi $api */

$catalogFile = $api->PobierzKatalogSIMCAdr(); // downloads the SIMC catalogue in address version
$fileObject = $catalogFile->dump(); // Dumps the catalogue content into a file \SplFileObject

Supported functions

For know the SDK supports the following functions:

  • CzyZalogowany
  • PobierzDateAktualnegoKatTerc
  • PobierzDateAktualnegoKatNTS
  • PobierzDateAktualnegoKatSimc
  • PobierzDateAktualnegoKatUlic
  • PobierzListeWojewodztw
  • PobierzListePowiatow
  • PobierzListeGmin
  • PobierzGminyiPowDlaWoj
  • PobierzKatalogTERC
  • PobierzKatalogTERCAdr
  • PobierzKatalogNTS
  • PobierzKatalogSIMCAdr
  • PobierzKatalogSIMC
  • PobierzKatalogSIMCStat
  • PobierzKatalogULIC
  • PobierzKatalogULICAdr
  • PobierzKatalogULICBezDzielnic
  • PobierzKatalogWMRODZ
  • PobierzSlownikRodzajowJednostek
  • PobierzSlownikCechULIC
  • PobierzSlownikRodzajowSIMC

Feel free to contrubute and add support for more functions.