cdek-it/sdk2.0

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

1.0.1 2024-07-22 03:30 UTC

This package is auto-updated.

Last update: 2024-09-09 13:34:38 UTC


README

Build Status Scrutinizer Code Quality Code Coverage Packagist

来自TTATPuOT的库更新列表

实现API v2.0以与СДЭК配送服务集成。此SDK可以帮助您更快地将СДЭК配送服务集成到自己的项目中。

SDK功能

  • 创建订单
  • 订单信息
  • 删除订单
  • 订阅webhooks(订单状态和打印表单状态)
  • 订阅webhooks信息
  • 删除webhooks订阅
  • 获取PВЗ列表
  • 创建呼叫快递员的申请
  • 呼叫快递员的申请信息
  • 删除呼叫快递员的申请
  • 创建打印运单的申请
  • 创建打印SKU位置的申请
  • 获取城市列表
  • 获取地区列表

要使用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许可证