README

需求

地址对象示例

创建地址对象有多种方式。

//Method 1
$address1 = new Address([
    'ID' => 1,
    'Address2' => '123 Fake St.',
    'City' => 'Springfield',
    'State' => 'CA',
    'Zip4' => 90210
]);

//Method 2
$address2 = new Address();

$address2->setID('1');
$address2->setAddress2('123 Fake St.');
$address2->setCity('Springfield');
$address2->setState('CA');
$address2->setZip4(90210);

两种方法都可以使用，并且可以使用 'set' 方法在运行时更新或覆盖地址对象。

邮编对象示例

创建邮编对象有多种方式。

//Method 1
$zipCode = new ZipCode(['ID' => 123, 'Zip5' => '90210']);

//Method 2
$zipCode = new ZipCode();
$zipCode->setID(123);
$zipCode->setZip5(90210)

两种方法都可以使用，并且可以使用 'set' 方法在运行时更新或覆盖邮编对象。

地址验证示例

地址验证是 USPS API 方法，可以确认或纠正提交的地址。一次可以添加和验证最多 5 个地址。

$address = new Address([
    '@ID' => 1,
    'Address2' => '123 Fake St.',
    'City' => 'Springfield',
    'State' => 'CA',
    'Zip4' => 90210
]);
$addressValidate = new AddressValidate();
$addressValidate->addAddress($address);

$response = $addressValidate->validate();

if ($addressValidate->isSuccess()) {

    //do stuff

} else {
    
    $addressValidate->getErrorMessage();

}

响应将包括更正后的地址，但如果不完全有效，也可能返回其他可能的地址。

城市州查找示例

城市州查找是 USPS API 方法，在提供邮编对象时查找城市和州。

$zipCode = new ZipCode(['ID' => 123, 'Zip5' => 20500]);
$cityStateLookup = new CityStateLookup(['userID' => $_ENV['USPS_USERID']]);
$cityStateLookup->addZipCode($zipCode);
$result = $cityStateLookup->lookup();

结果包括城市和州信息，可以引用邮编对象中包含的 ID。

邮编查找示例

$address = new Address([
    '@ID' => 1,
    'Address2' => '123 Fake St.',
    'City' => 'Springfield',
    'State' => 'CA',
    'Zip4' => 90210
]);
$zipCodeLookup = new ZipCodeLookup();
$zipCodeLookup->addAddress($address);
$result = $zipCodeLookup->lookup();

提供的结果将返回邮编和可选的 +4 代码。

跟踪示例

$track = new Track('TrackID' => '940000000000000012345');
$result = $track->track();

提供的结果将是跟踪信息的摘要以及所有详细步骤的列表。

许可

     __  ___      ____  _     ___                           _                    __
    /  |/  /_  __/ / /_(_)___/ (_)___ ___  ___  ____  _____(_)___  ____   ____ _/ /
   / /|_/ / / / / / __/ / __  / / __ `__ \/ _ \/ __ \/ ___/ / __ \/ __ \ / __ `/ /
  / /  / / /_/ / / /_/ / /_/ / / / / / / /  __/ / / (__  ) / /_/ / / / // /_/ / /
 /_/  /_/\__,_/_/\__/_/\__,_/_/_/ /_/ /_/\___/_/ /_/____/_/\____/_/ /_(_)__,_/_/

USPS API PHP Library
Copyright (c) Multidimension.al (http://multidimension.al)
Github : https://github.com/multidimension-al/usps

Licensed under The MIT License
For full copyright and license information, please see the LICENSE file
Redistributions of files must retain the above copyright notice.

@copyright  Copyright © 2017-2019 Multidimension.al (http://multidimension.al)
@link       https://github.com/multidimension-al/usps Github
@license    https://open-source.org.cn/licenses/mit-license.php MIT License

多维度 / usps

维护者

详细信息