README

Laravel getAddress.io 扩展包

此扩展包允许您轻松与 getAddress.io API 交互，并将完整邮政编码结果缓存以减少配额使用。

在项目的 composer.json 中要求此扩展包。

composer require laralabs/get-address-io

发布配置文件。

php artisan vendor:publish --tag=getaddress-config

编辑配置文件并设置您需要的设置，缓存默认是禁用的，您需要设置以下环境变量

GETADDRESS_API_KEY=
GETADDRESS_ADMIN_KEY=

如果您已启用缓存，请确保运行迁移

php artisan migrate

有一个辅助函数和外观提供，请选择您偏好的方法。

外观位于 Laralabs\GetAddress\Facades\GetAddress

目前支持的端点（其他端点的支持即将推出）

使用 find 端点进行查找

$results = get_address()->find($postcode, $property);

$property 参数是可选的，仅搜索邮政编码将返回该邮政编码的所有结果，如果已启用缓存，还会缓存数据。

使用 autocomplete 端点进行查找

$results = get_address()->autocomplete($searchTerm, ['top' => '20']);

第二个参数支持发送到 POST 请求的参数数组，上面的示例显示了将返回结果设置为最大允许值 20。

使用 get 端点进行查找

$results = get_address()->get($addressId);

这与 autocomplete 端点一起使用以返回完整的地址信息，$addressId 参数必须是自动完成响应返回的 ID。

如果存在问题，请在 GitHub 上提出问题。

这是一个开源软件，许可协议为 MIT 许可证。