README

这是官方包，它以易于使用的方式提供完整的面向对象的接口，用于所有公开的iPOST REST API方法，并简化了用PHP构建请求和接收响应的过程。

API版本：1.17

库包含用于正确构建和发送请求以及以对象形式接收具有类型化字段的响应的SDKClient。

库还包含用于在订单状态变更时从服务器接收通知的SDKNotify。

安装

最低版本 PHP 7.4

此库是在PSR-18（实现HTTP客户端的标准接口）之上构建的。因此，您需要安装或使用已存在于您项目中的任何实现PSR-18接口的HTTP客户端。

如果您的项目中还没有PSR-18客户端，或者您不知道它是怎么回事，或者您不在乎使用哪个，只需安装任何一个，例如

composer require guzzlehttp/guzzle

要安装SDK，请执行以下命令

composer require ipost/php-sdk

快速开始

$sdkClient = new SDKClient($yourIpostAccessToken, $httpClient);

$order = $sdkClient->getOrder($orderId);

echo $order->description;

• $sdkClient - 包含所有与API交互的方法。
• $httpClient - 这是任何PSR-18兼容的HTTP客户端。
• $yourIpostAccessToken - 您可以在iPOST网站的客户个人账户中获得的访问令牌。

使用IDE中的自动完成和提示

SDKClient方法

• getOrders - 获取所有订单，并按页分拆。
• getOrder - 获取特定订单的完整描述。
• createOrder - 创建订单。
• previewOrder - 评估运输成本。
• updateOrder - 更改运输成本的附加费。
• cancelOrder - 取消订单。
• addReview - 创建关于快递员的评论。
• updateReview - 编辑评论。
• deleteReview - 删除评论。
• getTracking - 获取快递员当前地理位置。
• getOrderReviews - 获取关于订单的所有评论。
• getCourierReviews - 获取关于快递员的所有评论。
• getPaymentCards - 获取已绑定支付卡列表。

SDKNotify方法

• getOrderStatusUpdated - 获取带有额外信息的订单新状态。