README

GetAddress IO服务的简单包装器。允许从提供的邮政编码检索地址信息，以及其他服务。

安装

在您开始使用GetAddress IO之前，您需要注册API密钥。您可以使用免费的API密钥30天，然后切换到付费计划。

您可以在以下网址获取API密钥并了解更多信息：https://getaddress.io/

通过Composer

$ composer require ashleighsims/get-address-wrapper

Laravel

如果您在Laravel中使用此包，则已启用自动发现，因此您应该能够立即开始使用（使用Laravel 5.5及更高版本）

如果您不使用Laravel 5.5及更高版本，您将需要手动注册一些内容...

在app.php文件中注册提供者

AshleighSims\GetAddressWrapper\Laravel\GetAddressWrapperServiceProvider::class

可选地注册外观

'GetAddress' => AshleighSims\GetAddressWrapper\Laravel\GetAddressWrapperServiceProvider::class

请确保在开始之前已将以下环境变量添加到您的.env文件中。

环境变量

将以下环境变量添加到您的.env文件中。

GET_ADDRESS_BASE_URL="https://api.getaddress.io"
GET_ADDRESS_API_KEY=""
GET_ADDRESS_ADMINISTRATION_API_KEY=""
GOOGLE_PLACES_API_KEY=""

用法

Laravel

通过控制器进行依赖注入

use AshleighSims\GetAddressWrapper\GetAddressWrapper;
...

private $getAddress;

public function __construct(GetAddressWrapper $getAddress) {
    $this->getAddress = $getAddress;
}

public function getPostcodeAddressList() {
    $response = $this->getAddress->findByPostcode()->find('SW1A 1AA');
}

...

外观

use AshleighSims\GetAddressWrapper\Laravel\Facades\GetAddressWrapper;

...

public function getAddress() {
    $response = GetAddressWrapper::findByPostcode()->find('SW1A 1AA');
}

...

通用用法

查找

从邮政编码获取地址列表

$getAddress = new GetAddressWrapper('api-key', 'admin-api-key', 'google-places-api-key', 'https://api.getAddress.io');
$response = $getAddress->findByPostcode()->find('SW1A 1AA');

返回：AshleighSims\GetAddressWrapper\Response\Address对象数组

从邮政编码和建筑号获取地址

$getAddress = new GetAddressWrapper('api-key', 'admin-api-key', 'google-places-api-key', 'https://api.getAddress.io');
$response = $getAddress->findByPostcode()->findWithNumber('SW1A 1AA', 'Buckingham Palace');

返回：AshleighSims\GetAddressWrapper\Response\Address对象

距离

$getAddress = new GetAddressWrapper('api-key', 'admin-api-key', 'google-places-api-key', 'https://api.getAddress.io');
$response = $getAddress->distance()->between('SW1A 1AA', 'SL4 1QF');

返回：AshleighSims\GetAddressWrapper\Response\Distance对象

自动完成 - 邮政编码

$getAddress = new GetAddressWrapper('api-key', 'admin-api-key', 'google-places-api-key', 'https://api.getAddress.io');
$response = $getAddress->autoCompletePostcode()->complete('SW1A');

返回：AshleighSims\GetAddressWrapper\Response\GooglePlacesPostcodePrediction对象

自动完成 - 地点

地点

$getAddress = new GetAddressWrapper('api-key', 'admin-api-key', 'google-places-api-key', 'https://api.getAddress.io');
$response = $getAddress->>autoCompletePlaces()->complete('Buckingham');

返回：AshleighSims\GetAddressWrapper\Response\GooglePlacesPrediction对象数组

地点详情

$getAddress = new GetAddressWrapper('api-key', 'admin-api-key', 'google-places-api-key', 'https://api.getAddress.io');
$response = $getAddress->autoCompletePlaces()->findByGooglePlacesId('ChIJtV5bzSAFdkgRpwLZFPWrJgo');

返回：AshleighSims\GetAddressWrapper\Response\GooglePlace对象

用法

当天

$getAddress = new GetAddressWrapper('api-key', 'admin-api-key', 'google-places-api-key', 'https://api.getAddress.io');
$response = $getAddress->usage()->get();

返回：AshleighSims\GetAddressWrapper\Response\Usage对象

给定日期

$getAddress = new GetAddressWrapper('api-key', 'admin-api-key', 'google-places-api-key', 'https://api.getAddress.io');
$response = $getAddress->usage()->getByDate('18/02/2020', 'd/m/Y');

返回：AshleighSims\GetAddressWrapper\Response\Usage对象

日期范围

$getAddress = new GetAddressWrapper('api-key', 'admin-api-key', 'google-places-api-key', 'https://api.getAddress.io');
$response = $getAddress->usage()->getBetween('18/02/2020', '19/02/2020', 'd/m/Y');

返回：AshleighSims\GetAddressWrapper\Response\DailyUsage对象数组

私有地址列表

添加地址

$getAddress = new GetAddressWrapper('api-key', 'admin-api-key', 'google-places-api-key', 'https://api.getAddress.io');
$response = $getAddress->privateAddress()->add('SW1A 1AA', [
                                     'line1' => 'Ashleigh\'s Palace',
                                     'line2' => '',
                                     'line3' => '',
                                     'line4' => '',
                                     'locality' => '',
                                     'townOrCity' => 'London',
                                     'county' => '',
                                 ]);

返回：JSON解码的关联数组

删除地址

$getAddress = new GetAddressWrapper('api-key', 'admin-api-key', 'google-places-api-key', 'https://api.getAddress.io');
$response = $getAddress->privateAddress()->delete('SW1A 1AA', '1');

返回：JSON解码的关联数组

获取地址

$getAddress = new GetAddressWrapper('api-key', 'admin-api-key', 'google-places-api-key', 'https://api.getAddress.io');
$response = $getAddress->privateAddress()->get('SW1A 1AA', '1');

返回：AshleighSims\GetAddressWrapper\Response\PrivateAddress对象

列出地址

$getAddress = new GetAddressWrapper('api-key', 'admin-api-key', 'google-places-api-key', 'https://api.getAddress.io');
$response = $getAddress->privateAddress()->list('SW1A 1AA');

返回：AshleighSims\GetAddressWrapper\Response\PrivateAddress对象数组

变更日志

有关最近更改的更多信息，请参阅变更日志。

安全

如果您发现任何安全相关的问题，请通过sims@ashleighsims.co.uk发送电子邮件，而不是使用问题跟踪器。

许可

许可。有关更多信息，请参阅许可文件。