README

本仓库包含一个用于(英国)Royal Mail配送API的PHP SDK/接口：Royal Mail配送API

此模块处于alpha状态，尚未在Royal Mail服务器上进行测试。
现在应该可以使用它以开发模式与客户端系统集成，请参阅Wiki中的文档（也在创建中）。这不是官方SDK，我们（http://www.turtledesign.com/）是一家第三方集成商，因为为什么不可以，所以发布了带有开源许可的模块。

先决条件

• PHP 5.4或更高版本
• soap和openssl扩展必须启用
• fileinfo对于测试是必需的。

安装

- 使用Composer

composer是安装SDK的推荐方式。要将SDK用于项目，请将以下依赖项添加到应用程序的composer.json文件中，然后运行composer update --no-dev来获取SDK。

您可以使用Composer官方网站上的说明下载composer。

先决条件

• composer用于获取依赖项（见https://getcomposer.org.cn）

安装步骤

目前，SDK可在https://packagist.org.cn获取。要在项目中使用它，您需要将其包含为composer.json文件中的依赖项。有两种方法可以做到这一点

• 在项目根位置（项目composer.json所在位置）运行composer require 'turtledesign/royalmail-php:*@dev'命令

• 或，手动编辑composer.json文件中的require字段，并添加"turtledesign/royalmail-php" : "*@dev"到其中。

生成的示例composer.json将如下所示

{
  ...

  "name": "sample/website",
  "require": {
  	"turtledesign/royalmail-php" : "*@dev"
  }

  ...
}

- 直接下载（不使用Composer）

如果您不想使用composer，可以下载包含Royal Mail API SDK及其所有依赖项的SDK zip文件。

安装步骤

• 从我们的发布下载所需版本的zip存档。每个发布版本都将有一个direct-download-*.zip，其中包含PHP Rest API SDK及其依赖项。

• 解压并将项目中的vendor目录复制到您的项目目录中，例如项目根目录。

• 如果您的应用程序有bootstrap/autoload文件，您应该在其中添加include '<vendor directory location>/vendor/autoload.php'。<vendor directory>的位置应根据您在应用程序中下载的vendor目录的位置进行替换。

• 此autoload.php文件注册了一个自定义自动加载器，可以自动加载Royal Mail SDK文件，这允许您在应用程序中访问PHP SDK系统。

更多信息

• Royal Mail配送API服务页面
• API参考 - PDF
• 报告问题/功能请求