shippo/shippo-php

使用Shippo连接多个承运商(FedEx、UPS、USPS)的PHP库。


README

⚠️ Shippo不再积极维护此库
然而,您可以将其作为起点,并根据您的需求和API的未来更改进行更新。
您可以使用我们的Open API规范,结合OpenAPI GeneratorSwagger Codegen等工具来构建自己的库。

Build Status

Shippo是一个连接您与多个承运商(如USPS、UPS、DHL、加拿大邮政、澳大利亚邮政、UberRUSH等)的API,通过一个界面即可完成。

使用我们的默认USPS和DHL Express账户,10分钟内打印出运货标签。无需注册承运商账户即可开始。

要求

  • PHP 5.6或更高版本。

  • Shippo账户 - 注册免费,使用API免费。只需为打印真实标签付费,测试标签免费。

安装

使用Composer安装

  • 获取Composer

  • 将以下内容添加到您的composer.json文件中

      {
        "require": {
          "shippo/shippo-php": "1.*"
        }
      }
    
  • 通过以下方式安装

      composer.phar install
    
  • 要使用绑定,可以使用Composer的自动加载

      require_once('vendor/autoload.php');
    

    或者手动

      require_once('/path/to/vendor/shippo/shippo-php/lib/Shippo.php');
    

使用Laravel安装

在Laravel中,您可以像通常一样安装库。然后,在您的app/Providers/AppServiceProvider.php文件中的boot()方法中添加以下内容

\Shippo::setApiKey(env('SHIPPO_API_KEY'));

要利用配置缓存,您可以在config/services.php中设置一个配置参数,并通过配置检索您的API密钥。

\Shippo::setApiKey($this->app['config']['services.shippo.key']);

从现在起,您可以在应用程序的任何地方使用Shippo库,而无需在访问时设置密钥。

测试

安装上述依赖项后,可以运行测试套件

    ./vendor/bin/phpunit

您还可以运行单个测试

    ./vendor/bin/phpunit AddressTest.php

入门

简单用法如下

    // Replace <API-KEY> with your Shippo API Key
    Shippo::setApiKey("<API-KEY>");
    $address = Shippo_Address::
        create(
            array(
                 'object_purpose' => 'QUOTE',
                 'name' => 'John Smith',
                 'company' => 'Initech',
                 'street1' => '6512 Greene Rd.',
                 'city' => 'Woodridge',
                 'state' => 'IL',
                 'zip' => '60517',
                 'country' => 'US',
                 'phone' => '773 353 2345',
                 'email' => '[email protected]',
                 'metadata' => 'Customer ID 23424'
            ));
            
        var_dump($address);

我们创建了许多示例,以涵盖最常见的用例。您可以在examples文件夹中找到示例代码文件。我们涵盖的一些用例包括

文档

请参阅https://goshippo.com/docs以获取最新文档。

关于Shippo

只需一个集成即可与多个不同的承运商连接,获取折扣运货标签,跟踪包裹等等。您可以使用自己的承运商账户,或者利用我们与USPS和DHL Express的折扣价格。使用Shippo可以轻松处理多个承运商集成、比价、跟踪和其他运输工作流程的各个部分。我们为您提供API和仪表板,满足您的所有运输需求。

支持的功能

Shippo API 提供了全面支持承运和运输功能。以下只是我们通过 API 支持的一些功能:

支持的功能

Shippo API 提供了全面支持承运和运输功能。以下只是我们通过 API 支持的一些功能:

  • 运费和标签 - 文档
  • 只需跟踪号码即可跟踪任何运输 - 文档
  • 批量标签生成 - 文档
  • 多件货物运输 - 文档
  • 货运单和扫描表 - 文档
  • 海关申报和商业发票 - 文档
  • 地址验证 - 文档
  • 包括以下内容的整合商支持:
    • DHL 电子商务
    • UPS 邮政创新
    • FedEx Smartpost
  • 附加服务:货到付款、认证邮件、投递确认等 - 文档