api-postcode / api-postcode-laravel
Laravel package for api-postcode
Installs: 4 706
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 1
Forks: 8
Open Issues: 1
Requires
- php: >=5.5.9
- api-postcode/php-client: ^1.0
- illuminate/support: ^5.8 || ^6.0 || ^7.0 || ^8.0
This package is not auto-updated.
Last update: 2024-12-11 07:46:41 UTC
README
A laravel package for fetching Address details
For more information see: https://api-postcode
Requirements
Laravel 5.1 or later
Installation
Installation is a quick 3 step process:
- Download api-postcode-laravel using composer
- Enable the package in app.php
- Configure your Api Postcode credentials
Step 1: Download api-postcode-laravel using composer
Add api-postcode/api-postcode-laravel by running the command:
composer require api-postcode/api-postcode-laravel
Step 2: Enable the package in app.php
Register the Service in: config/app.php
ApiPostcode\ApiPostcodeServiceProvider::class,
Optional - Register the Facade in: config/app.php
'aliases' => [ //... 'Postcode' => ApiPostcode\Facade\Postcode::class, ];
Step 3: Configure Api Postcode credentials
php artisan vendor:publish --provider="ApiPostcode\ApiPostcodeServiceProvider"
Add this in you .env file
API_POSTCODE_TOKEN=secret-token-from-api-postcode
Usage
$address = app('api.postcode')->fetchAddress('1012JS', 1); $address->getStreet(); // Dam $address->getCity(); // Amsterdam $address->getHouseNumber(); // 1 $address->getZipCode(); // 1012JS $address->getLongitude(); // 4.4584 $address->getLatitude(); // 52.2296
Or use the Facade:
$address = Postcode::fetchAddress('1012JS', '1')
Or straight in routes:
$router->get('postcode/{zipCode}/{number}', function ($zipCode, $number) { return Postcode::fetchAddress($zipCode, $number); });