dimanzver/sdek-sdk

PHP SDK,用于集成CDEK公司API v2.0服务

0.1.11 2024-09-01 11:26 UTC

This package is auto-updated.

Last update: 2024-09-01 11:26:43 UTC


README

Build Status Scrutinizer Code Quality Code Coverage Packagist

实现API v2.0,用于与CDEK快递服务集成。此SDK有助于更快地将CDEK快递服务集成到您的项目中。

SDK功能

  • 创建订单
  • 订单信息
  • 删除订单
  • 订阅Webhooks(订单状态和打印表单状态)
  • Webhooks订阅信息
  • 删除Webhooks订阅
  • 获取快递点列表
  • 创建调用快递员申请
  • 调用快递员申请信息
  • 删除调用快递员申请
  • 创建形成运单打印表单的请求
  • 创建形成条形码标签打印表单的请求
  • 获取城市列表
  • 获取区域列表

要使用所有API方法,必须拥有集成服务访问权限,这些权限仅在签订CDEK公司合同后提供。

要求

要求非常简单。需要PHP 7.1或更高版本。

此SDK使用PSR-18 (HTTP-client)规范。这意味着可以使用任何支持该规范的HTTP客户端。如果您的客户端不支持此规范,可以查看适用于大多数流行HTTP客户端的适配器

安装

通过Composer包管理器安装

composer require cdek-it/sdk2.0

文档

完整文档位于此处

使用示例

$client = new Psr18Client();
$cdek = new \CdekSDK2\Client($client);
$cdek->setAccount('account');
$cdek->setSecure('secure');

// создание заказа
$order = \CdekSDK2\BaseTypes\Order::create([...]);
$res = $cdek->orders()->add($order);

if ($res->hasErrors()) {
    // Обрабатываем ошибки
    foreach ($res->getErrors() as $error) {
        //считываем ошибки
    }
}
if ($res->isOk()) {
    $cdek_order = $cdek->formatResponse($res, \CdekSDK2\BaseTypes\Order::class);
//    $cdek_order->entity->uuid;
}

// получение информации о заказе
$res = $cdek->orders()->get($cdek_order->entity->uuid);
if ($res->isOk()) {
    $cdek_order = $cdek->formatResponse($res, \CdekSDK2\Dto\OrderInfo::class);
}




//получить список офисов
$res = $cdek->offices()->getFiltered(['country_code' => 'kz']);
if ($res->isOk()) {
    $pvzlist = $cdek->formatResponseList($res, \CdekSDK2\Dto\PickupPointList::class);
//    $pvzlist->items;
}

测试

运行测试

$ composer test

许可证

本项目根据MIT许可证分发。