Laravel Package

De Laravel package is beschikbaar via GitHub.

Installatie

Je kunt de Laravel package eenvoudig installeren via Composer.

Na installatie kun je de configuratiebestanden publiceren met het volgende Artisan-commando:

Vervolgens kun je jouw API-key toevoegen aan het .env-bestand:

Zoeken van adressen

Enkel adres zoeken op basis van een postcode en huisnummer

use Label84\NederlandPostcode\Laravel\Facades\NederlandPostcode;

$address = NederlandPostcode::find(
        postcode: '1118BN',
        number: 800,
        addition: null,
        attributes: [
            'coordinates',
        ],
    );
    

Als er geen adres wordt gevonden, dan krijg je een NoAddressFoundException terug. Als er meerdere adressen worden gevonden, dan krijg je een MultipleAddressesFoundException terug. Deze exceptions kun je afvangen met een try-catch blok.

Adressen zoeken op basis van een postcode en huisnummer

use Label84\NederlandPostcode\Laravel\Facades\NederlandPostcode;

$address = NederlandPostcode::list(
        postcode: '1015CN',
        number: 10,
        addition: null,
        attributes: [
            'coordinates',
        ],
    );
    

Je krijgt een collectie met adressen terug. Als er geen adressen worden gevonden, dan krijg je een lege collectie terug.

Opvangen van fouten

Als je een fout wilt opvangen die optreedt tijdens het maken van een API-aanroep, kun je de NederlandPostcodeException gebruiken.

use Label84\NederlandPostcode\Laravel\Facades\NederlandPostcode;
use Label84\NederlandPostcode\Exceptions\NederlandPostcodeException;

try {
    $address = NederlandPostcode::find(
        postcode: '1118BN',
        number: 800,
        addition: null,
        attributes: [
            'coordinates',
        ],
    );
} catch (NederlandPostcodeException $exception) {
    // je kunt hier de fout afhandelen
}
    

Voor meer informatie over de Laravel package, kun je de GitHub repository bezoeken.