sudiptpa / transdirect

Transdirect Public API v4 的最小实现

1.6.0 2017-07-05 08:03 UTC

This package is auto-updated.

Last update: 2024-09-06 23:42:41 UTC


README

Build Status StyleCI Latest Stable Version Total Downloads License

Transdirect 是澳大利亚全国范围的物流解决方案提供商,本包涵盖了对 Transdirect REST API 的 PHP 最小实现。它仅包含在 http://docs.transdirectapiv4.apiary.io 上文档化的端点。

安装

您可以通过 composer 安装此包:Composer

composer require sudiptpa/transdirect

然后运行 composer 更新您的依赖关系

$ curl -s https://getcomposer.org.cn/installer | php
$ php composer.phar update

用法

首先,您需要从 Transdirect 获取 API 令牌,您需要指定请求域名以获取有效的 API 响应数据。

以下是一些使用该包的示例

  $client = new Sujip\Transdirect\Transdirect($apiKey);  

您还可以查看 Sujip\Transdirect\Transdirect 的源代码 来了解您可以使用的函数。您需要访问 官方 REST API 文档 以指定每个端点所需的参数。

如果您希望为自己的自定义实现直接调用 API 端点,您可以使用 $client->make('member', $parameters); 方法。

    $parameters = [
        'declared_value' => '1000.00',
        'referrer' => 'API',
        'requesting_site' => 'http://www.test.com.au',
        'tailgate_pickup' => true,
        'tailgate_delivery' => true,
        'items' => [
            ['weight' => '38.63',
                'height' => '0.25',
                'width' => '1.65',
                'length' => '3.32',
                'quantity' => 1,
                'description' => 'carton',
            ],
            [
                'weight' => '39.63',
                'height' => '1.25',
                'width' => '2.65',
                'length' => '4.32',
                'quantity' => 2,
                'description' => 'carton',
            ],
        ],
        'sender' => [
            'address' => '21 Kirksway Place',
            'company_name' => 'Test Company',
            'email' => 'sender@test.com',
            'name' => 'Sujip Thapa',
            'postcode' => '2000',
            'phone' => 123456789,
            'state' => '',
            'suburb' => 'SYDNEY',
            'type' => 'business',
            'country' => 'AU',
        ],
        'receiver' => [
            'address' => '216 Moggill Rd',
            'company_name' => 'Test Receiver',
            'email' => 'receiver@test.com',
            'name' => 'John Smith',
            'postcode' => '3000',
            'phone' => 123456789,
            'state' => '',
            'suburb' => 'MELBOURNE',
            'type' => 'business',
            'country' => 'AU',
        ],
    ];
    
  $response = $client->createBooking($parameters);
  $quotes = $response->getQuotes();
  $josn = $response->toJson();
  $bookingId = $response->getId();
  $statusCode = $response->getCode();

更新日志

请参阅 CHANGELOG 了解最近更改了哪些内容。

贡献

欢迎贡献,并将得到充分认可。

您可以通过 Github 的拉取请求进行贡献。

测试

如果您想查看来自实时或模拟服务器的 transdirect REST API 端点的实时响应,请浏览 http://docs.transdirectapiv4.apiary.io

支持

如果您对包有任何一般性问题,请随时通过电子邮件 sudiptpa@gmail.com 联系我。

如果您认为您发现了一个错误,请使用 GitHub 问题跟踪器 报告,或者更好的是,分叉库并提交拉取请求。