README

此API客户端可以帮助您操作NZ Post Address Checker API。您可以使用任何PSR-16 Simple Cache来节省查找次数的费用。

安装

composer require digitalpianism/nzpost-client

示例

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

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

认证并获取客户端实例

use DigitalPianism\NzPostClient\NzPostClient;

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

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

使用PSR-16 Simple Cache认证并获取客户端实例

use Symfony\Component\Cache\Simple\FilesystemCache;
use DigitalPianism\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。这可以通过调用find或suggest资源找到，这些资源返回包括DPID的匹配项。

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

建议部分地址。

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

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

部分地址详情服务。

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

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