Laravel API Wrapper for Loqate / PCA Predict (formerly Postcode Anywhere)
, (*1)
This wrapper simplifies process of making API calls to Loqate web services down to a single line of code within your Laravel application!, (*2)
Dependency
This package requires the PHP cURL extension to be installed on your system., (*3)
Contents
Installation
, (*4)
Pull in the package using Composer, (*5)
composer require alexpechkarev/postcode-anywhere
Note: If you are using Laravel 5.5, the next steps are unnecessary. This package supports Laravel Package Discovery., (*6)
Include the service provider within config/app.php., (*7)
'providers' => [
...
PostcodeAnywhere\PAServiceProvider,
],
Include the facade within config/app.php., (*8)
'aliases' => [
...
'PA' => PostcodeAnywhere\PAFacade::class,
]
Configuration
, (*9)
This package supports configuration., (*10)
You can publish the config file with:, (*11)
php artisan vendor:publish --provider="PostcodeAnywhere\PAServiceProvider" --tag="config"
When published, the config/postcodeanywhere.php config file contains:, (*12)
<?php
return [
/*
|--------------------------------------------------------------------------
| Default parameters
|--------------------------------------------------------------------------
|
| Service key - required
| The key to use to authenticate to the service
| String - AA11-AA11-AA11-AA11
*/
'params' => [
'key' => env('PCA_KEY', 'AA11-AA11-AA11-AA11'),
],
/*
|--------------------------------------------------------------------------
| Service URL
|--------------------------------------------------------------------------
*/
'url' => 'https://services.postcodeanywhere.co.uk/',
/*
|--------------------------------------------------------------------------
| Registered Web Services
|--------------------------------------------------------------------------
| @see http://www.postcodeanywhere.co.uk/support/webservices/
*/
'services' => [
'find' => [
// PostcodeAnywhere Interactive RetrieveBySortcode (v1.00)
'BankAccountValidation' => 'BankAccountValidation/Interactive/RetrieveBySortcode/v1.00/',
// PostcodeAnywhere Interactive Find (v1.10)
'PAInteractiveFind' => 'PostcodeAnywhere/Interactive/Find/v1.10/',
// PostcodeAnywhere Interactive FindByPostcode (v1.00)
'FindByPostcode' => 'PostcodeAnywhere/Interactive/FindByPostcode/v1.00/',
// CapturePlus Interactive Find (v2.10)
'CPInteractiveFind' => 'CapturePlus/Interactive/Find/v2.10/',
// PostcodeAnywhere Interactive FindByAreaId (v1.00)
'FindByAreaId' => 'PostcodeAnywhere/Interactive/FindByAreaId/v1.00/',
// PostcodeAnywhere Interactive FindByBuilding (v1.00)
'FindByBuilding' => 'PostcodeAnywhere/Interactive/FindByBuilding/v1.00/',
// PostcodeAnywhere Interactive FindByLocalityId (v1.00)
'FindByLocalityId' => 'PostcodeAnywhere/Interactive/FindByLocalityId/v1.00/',
// PostcodeAnywhere Interactive FindByOrganisation (v1.00)
'FindByOrganisation' => 'PostcodeAnywhere/Interactive/FindByOrganisation/v1.00/',
// PostcodeAnywhere Interactive FindByPartialPostcode (v1.00)
'FindByPartialPostcode' => 'PostcodeAnywhere/Interactive/FindByPartialPostcode/v1.00/',
// PostcodeAnywhere Interactive FindByParts (v1.00)
'FindByParts' => 'PostcodeAnywhere/Interactive/FindByParts/v1.00/',
// PostcodeAnywhere Interactive FindByPoBox (v1.00)
'FindByPoBox' => 'PostcodeAnywhere/Interactive/FindByPoBox/v1.00/',
// PostcodeAnywhere Interactive FindByStreet (v1.00)
'FindByStreet' => 'PostcodeAnywhere/Interactive/FindByStreet/v1.00/',
// PostcodeAnywhere Interactive FindByStreetId (v1.00)
'FindByStreetId' => 'PostcodeAnywhere/Interactive/FindByStreetId/v1.00/',
// PostcodeAnywhere Interactive FindStreets (v1.00)
'FindStreets' => 'PostcodeAnywhere/Interactive/FindStreets/v1.00/',
// PostcodeAnywhere Interactive ListAliases (v1.10)
'ListAliases' => 'PostcodeAnywhere/Interactive/ListAliases/v1.10/',
// PostcodeAnywhere Interactive ListAreas (v1.00)
'ListAreas' => 'PostcodeAnywhere/Interactive/ListAreas/v1.00/',
// PostcodeAnywhere Interactive ListCounties (v1.00)
'ListCounties' => 'PostcodeAnywhere/Interactive/ListCounties/v1.00/',
],
'retrieve' => [
// PostcodeAnywhere Interactive RetrieveById (v1.30)
'RetrieveById' => 'PostcodeAnywhere/Interactive/RetrieveById/v1.30/',
// PostcodeAnywhere Interactive RetrieveByAddress (v1.20)
'RetrieveByAddress' => 'PostcodeAnywhere/Interactive/RetrieveByAddress/v1.20/',
// CapturePlus Interactive Retrieve (v2.10)
'CPInteractiveRetrieve' => 'CapturePlus/Interactive/Retrieve/v2.10/',
// PostcodeAnywhere Interactive RetrieveByIdWithEmail (v1.20)
'RetrieveByIdWithEmail' => 'PostcodeAnywhere/Interactive/RetrieveByIdWithEmail/v1.20/',
// PostcodeAnywhere Interactive RetrieveByParts (v1.00)
'RetrieveByParts' => 'PostcodeAnywhere/Interactive/RetrieveByParts/v1.00/',
// PostcodeAnywhere Interactive RetrieveByPostcodeAndBuilding (v1.30)
'RetrieveByPostcodeAndBuilding' => 'PostcodeAnywhere/Interactive/RetrieveByPostcodeAndBuilding/v1.30/',
// PostcodeAnywhere Interactive RetrieveChanges (v1.00)
'RetrieveChanges' => 'PostcodeAnywhere/Interactive/RetrieveChanges/v1.00/',
// PostcodeAnywhere Interactive RetrieveHistoryById (v1.00)
'RetrieveHistoryById' => 'PostcodeAnywhere/Interactive/RetrieveHistoryById/v1.00/',
],
],
/*
|--------------------------------------------------------------------------
| End point
|--------------------------------------------------------------------------
*/
'endpoint' => [
'xml' => 'xmle.ws?',
'xmla' => 'xmla.ws?',
'json' => 'json.ws?',
'jsonp' => 'json2.ws?',
'json3' => 'json3.ws?',
'json extra' => 'json3ex.ws?',
'csv' => 'csv.ws?',
'tsv' => 'tsv.ws?',
'dataset' => 'dataset.ws?',
'recordset' => 'recordset.ws?',
'htmltable' => 'htmltable.ws?',
'image' => 'image.ws?',
'pdf' => 'pdf.ws?',
'psv' => 'psv.ws?',
],
];
The configuration file has a multidimensional array called 'services' that defines web services by type; 'find' and 'retrieve'., (*13)
Feel free to add / remove any other Loqate / PCA Predict Services., (*14)
Usage
, (*15)
Here is an example of making call to find address records for the given postcode., (*16)
Within your application call \PA::getResponse( array $param ) with array of parameters., (*17)
$param = [
'action' => 'Web Service',
'parameters' => 'array of parameters for Web Service called'
];
Example:, (*18)
$param = [
'find' => 'FindByPostcode', // perform 'find' action calling 'FindByPostcode' web service
'param' => ['postcode'=>'SW1A 1AA', 'endpoint'=>'json'] // parameters for web service called
];
Note: endpoint is defaulted to json when it is omitted., (*19)
Detailed Example
, (*20)
You could have a Service Class, for example Loqate, and within this class you can do the heavy lifting in a __construct or __invoke magic method. Please find an example below:, (*21)
<?php
namespace App\Services;
class Loqate
{
/**
* @var \Illuminate\Support\Collection
*/
public $addresses;
/**
* Retrieve an address by it's postcode.
*
* @param string $postcode
*
* @return array
*/
public function __construct($postcode)
{
// Build an addresses collection
$addresses = collect();
// Step 1: Search by postcode to get Loqate's internal ID.
$param = [
'find' => 'FindByPostcode',
'param' => [
'postcode' => $postcode,
'endpoint' => 'json',
],
];
// JSON Decode the returned response into an array
$findResponse = json_decode(\PA::getResponse($param), true);
// Loop through the returned array
foreach ($findResponse as $findItem) {
if (array_key_exists('Id', $findItem)) {
// Step 2: Retrieve the full address by it's ID.
$param = [
'retrieve' => 'RetrieveById',
'param' => [
'id' => $findItem['Id'],
],
];
// JSON Decode the returned response into an array
$retrieveResponse = json_decode(\PA::getResponse($param), true);
// Loop through the returned array
foreach ($retrieveResponse as $item) {
// Push to the collection
$addresses->push($item);
}
}
}
// Convert all keys to snake case
$addresses = $addresses->map(function ($value, $key) {
return collect($value)->keyBy(function ($value, $key) {
return snake_case($key);
});
});
$this->addresses = $addresses;
}
/**
* Retrieve the Addresses Property as an array.
*
* @return array
*/
public function toArray()
{
return $this->addresses->toArray();
}
/**
* Retrieve the Addresses Property unmodified.
*
* @return \Illuminate\Support\Collection
*/
public function get()
{
return $this->addresses;
}
}
To use the above Service class, you could do something souch as the following:, (*22)
$postcode = 'WR5 3DA';
$addresses = new App\Services\Loqate($postcode);
return $addresses->toArray();
For more information, please see Loqate's API documentation PostcodeAnywhere Interactive FindByPostcode (v1.00) for required parameters and response., (*23)
Support
, (*24)
If you find an error or have any suggestions, please open an issue on GitHub., (*25)
License
, (*26)
Laravel API wrapper for Loqate / PCA Predict (formerly Postcode Anywhere) is released under the MIT License. See the bundled LICENSE file for details., (*27)
Wallogit.com
