bigbank/omniva

Library to interface with Omniva web API-s

0.2.0 2017-05-29 08:10 UTC

Requires

• php: >=5.6
• ext-curl: *
• ext-openssl: *
• ext-soap: *
• ext-xml: *
• league/container: ~2.0

Requires (Dev)

• phpmd/phpmd: ~2.3
• phpunit/phpunit: ~5
• squizlabs/php_codesniffer: ~2.5
• wsdl2phpgenerator/wsdl2phpgenerator: ~3

Apache-2.0

• Bigbank AS

• bigbank
• omniva
• eesti post

README

A PHP library for interfacing with Omniva (former Estonian Postal Service) web API-s without dealing with SOAP (too much).

Install

Via Composer

$ composer require bigbank/omniva

The library requires PHP >=5.6, curl, soap and openssl extensions.

Usage

// Instantiate the main class
$omniva = new Omniva;

// Ask for a service (see: Services)
$addressSearchService = $omniva->getService(AddressSearchInterface::class)
    ->setApiKey(getenv('OMNIVA_PASSWORD'));

// Get a list of all matching addresses for a partial input
$addresses = $addressSearchService->findAddresses('Tartu mnt 18');

print_r($addresses);

Example implementation in examples/search-address.php can be run with

$ OMNIVA_PASSWORD="<secret-string>" php examples/search-address.php

To use a HTTP proxy, set HTTP_PROXY environment variable.

Services

The library provides access to the following services:

Address Search

Get a list of physical addresses based on a partial input. Useful for applications like address auto-complete.

• Interface name: AddressSearchInterface
• Omniva service name: ANDMETEENUSED AADRESSKOMPONENTIDE PÄRIMISE TEENUS 2 SISEND 5_1 (VERS.1)
• WSDL: https://otseturundus.post.ee/aadressid/ws/singleAddress2_5_1.wsdl

Usage

$addressSearchService = $omniva->getService(AddressSearchInterface::class)
    ->setApiKey(getenv('OMNIVA_PASSWORD'))
    ->findAddresses('Tartu mnt 18');

You can change the URL of the Omniva API endpoint by manually instantiating AddressSearch:

$addressSearchService = new AddressSearch(
    new SingleAddress2_5_1PortTypeService($soapOptions, $wsdlUrl),
    new SingleAddress2_5_1Request
);

Sample Output

Array
(
    [0] => Array
        (
            [address] => Eesti Vabariik, Tartu maakond, Elva linn, Tartu maantee 18
            [addressNumber] => 18
            [county] => Tartu maakond
            [countyId] => 0078
            [designation] => 
            [flatNumber] => 
            [latitude] => 641443.84
            [level] => A7
            [longitude] => 6457217.29
            [mailboxType] => 
            [mainAddress] => 
            [municipality] => Elva linn
            [municipalityId] => 0170
            [municipalityType] => linn
            [nationalAddressId] => 7817000000000002H000019HC00000000
            [omnivaAddressId] => 3702034
            [postalIndex] => 61505
            [postOfficeBoxNumber] => 
            [settlement] => 
            [settlementId] => 0000
            [settlementType] => 
            [status] => Kontrollitud, kehtiv
            [territorialAddress] => 
            [territorialAddressType] => 
            [trafficSurface] => Tartu maantee
            [trafficSurfaceType] => tee
        )
)

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Development

Please see CONTRIBUTING for details.

Definitions

Definitions for terms used by Omniva API-s (in Estonian):

• EHAK - Eesti haldus- ja asustusjaotuse klassifikaator
• ADS - Aadressiandmete süsteem
• Põhiaadress - See on vajalik juhul kui objektil on küll mitu aadressi kuid aktiivselt kasutatakse ühte nendest ja teine on varuks. Näiteks kui on tegu tänava nurgal oleva majaga, millel on kaks aadressi. Hoone peasissekäik on ühelt tänavalt ja see aadress oleks sel juhul põhiaadress.

Related Materials

These materials (in Estonian) help to understand the address domain.

• Kohanimed Aadressiandmete Süsteemis, Maa-Amet 2008
• L-EST97 Eesti Geodeetiline süsteem
• ADS kontseptsioon

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Bigbank's developers
• All Contributors

License

The Apache 2.0 License (Apache-2.0). Please see License File for more information.