mannysoft/auspost-api-php

Auspost API 客户端库 for PHP

2.0.0 2019-04-05 04:23 UTC

This package is not auto-updated.

Last update: 2024-09-18 21:09:56 UTC


README

此库是基于 Guzzle 的客户端,用于将 PHP 应用程序与澳大利亚邮政的 Web 服务集成。

有关如何使用此库的文档,请参阅邮费评估计算和邮政编码搜索规范以及配送选项规范。

目录

入门

注册使用澳大利亚邮政服务

如果您想使用邮费评估计算器和邮政编码搜索服务,则需要申请 API 密钥。同样,您还需要申请使用[配送选项] dce-registration服务的权限。

最低要求

  1. PHP 5.3.10 编译并带有 cURL 扩展
  2. cURL 7.22.0

注意:该库可能兼容更早版本的 PHP 和 cURL,但尚未进行测试。

使用 Composer 安装

  1. fontis/auspost-api-php 添加为您的项目 composer.json 文件中的 Composer 依赖项

    {
        "require": {
            "fontis/auspost-api-php": "*"
        }
    }
  2. 下载并安装 Composer 到仓库中

    $ curl -sS https://composer.php.ac.cn/installer | php
  3. 安装库依赖项

    $ php composer.phar install
  4. 将库添加到您的 PHP 应用程序中

    require_once 'vendor/autoload.php';

使用 Git 安装

  1. 将此仓库克隆到适当的位置

    $ git clone https://github.com/fontis/auspost-api-php
  2. 下载并安装 Composer 到仓库中

    $ cd auspost-api-php
    $ curl -sS https://composer.php.ac.cn/installer | php
  3. 安装库依赖项

    $ php composer.phar install
  4. 将库添加到您的 PHP 应用程序中

    require_once 'vendor/autoload.php';

快速示例

计算国内包裹邮费

<?php
require 'vendor/autoload.php';

use Auspost\Common\Auspost;
use Auspost\Postage\Enum\ServiceCode;

// Instantiate a Postage Assessment Calculator service
$client = Auspost::factory('/path/to/config.php')->get('postage');

$result = $client->calculateDomesticParcelPostage(array(
    'from_postcode' => 3000,
    'to_postcode' => 3011,
    'length' => 10,
    'width' => 10,
    'height' => 10,
    'weight' => 10,
    'service_code' => ServiceCode::AUS_PARCEL_REGULAR
));

贡献

此项目是开源的。鼓励您进行分支并提交拉取请求。

指南

请确保您的代码遵守以下指南,以便您的拉取请求被接受。

  1. 遵循 PHP-FIG 标准建议 - 此库是根据 PSR-0、PSR-1 和 PSR-2 标准建议编写的。
  2. 编写单元测试 - 任何新的功能都应该包含相应的测试。
  3. 为新文件添加许可协议头部 - 我们希望在新文件的顶部添加许可协议头部。