antonmaslennikov/cdek-sdk2.0

PHP SDK,用于СДЭК公司集成服务API v2.0

dev-master / 0.0.1.x-dev 2024-02-28 13:02 UTC

This package is auto-updated.

Last update: 2024-09-28 14:12:18 UTC


README

Build Status Scrutinizer Code Quality Code Coverage Packagist

来自TTATPuOT的库更新列表

实现了API v2.0,用于与СДЭК运输服务集成。此SDK可以帮助更快地将СДЭК运输服务集成到您的项目中。

SDK功能

  • 创建订单
  • 订单信息
  • 删除订单
  • 订阅webhooks(订单状态和打印表单状态)
  • 订阅webhooks信息
  • 删除webhooks订阅
  • 获取PВЗ列表
  • 创建调用快递员的申请
  • 调用快递员申请信息
  • 删除调用快递员申请
  • 创建生成运单打印表的请求
  • 创建生成货签打印表的请求
  • 获取城市列表
  • 获取区域列表

要使用所有API方法,必须拥有集成服务的访问权限,这些权限仅在签订与СДЭК公司的合同后才能获得。

要求

要求很简单。需要PHP 7.1/8.0或更高版本。

此SDK使用PSR-18 (HTTP-client)规范。这意味着可以使用任何支持此规范的HTTP客户端作为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()) {
    // Обрабатываем ошибки
    // Если этого не сделать, в будущем будет ошибка RequestException
    foreach ($res->getErrors() as $error) {
        //считываем ошибки
    }
}
if ($res->isOk()) {
    $cdek_order = $cdek->formatResponse($res, \CdekSDK2\BaseTypes\Order::class);
    // $cdek_order->entity->uuid;
    // Если попытаться обработать ответ без проверки $res->isOk()
    // и при этом в ответе будут ошибки, то здесь выбросится исключение RequestException
}

// получение информации о заказе
$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许可证分发。