README

此 API 客户端可以帮助您与 NZ Post 地址检查 API 进行操作。您可以使用任何 PSR-16 简单缓存来保存查询次数，以节省资金。

安装

composer require dshumkov/nzpost-client

示例

地址检查 API 允许您自动完成并检查新西兰地址和邮编。它可以在网页表单或移动应用中使用。它由新西兰邮政的国家邮政地址数据库（NPAD）支持。

首先，您必须注册账户 https://www.nzpost.co.nz/business/developer-centre#data 并在那里创建新的应用程序以获取 API 凭据。

认证并获取客户端实例

use DShumkov\NzPostClient\NzPostClient;

$clientID = 'NZPOST_CLIENT_ID';
$secret = 'NZPOST_CLIENT_SECRET';

$Client = new NzPostClient($clientID, $secret);

使用 PSR-16 简单缓存认证并获取客户端实例

use Symfony\Component\Cache\Simple\FilesystemCache;
use DShumkov\NzPostClient\NzPostClient;

$cache = new FilesystemCache();
$ttl = 31536000; // One year cache TTL

$clientID = 'NZPOST_CLIENT_ID';
$secret = 'NZPOST_CLIENT_SECRET';

$Client = new NzPostClient($clientID, $secret, $cache);
$Client->setTTL($ttl);

获取建议地址

$query = '1 Queen street';
$suggestedAddresses = $Client->suggest($query);

查找地址

$addressLines = [
    '1 Queen street',
    'CBD',
    'Auckland'
 ];
 $addresses = $Client->find($addressLines);

通过 DPID 获取地址详情

调用地址详情服务需要传递 DPID。这可以通过调用查找或建议资源来实现，这些资源返回包括 DPID 的匹配项。

$dpid='3111226';
$addressDetails = $Client->details($dpid);

建议部分地址。

建议部分地址服务接受部分地址查询，并将部分地址匹配列表转换为列表。

$query = 'queen';
$suggestedAddresses = $Client->suggestPartial($query);

部分地址详情服务。

部分地址详情服务接受唯一的部分_id，并返回关于匹配的部分地址的详细信息。

$uniqId = 82868;
$response = $Client->partialDetails($uniqId);

aotearoait / nzp-addresschecker

维护者

详细信息