dicr/yii2-cdek

API службы доставки СДЭК

5.0.0 2022-01-08 16:27 UTC

Requires

• php: ~8.0
• ext-curl: *
• ext-zlib: *
• dicr/yii2-helper: ~6.0
• dicr/yii2-http: ~4.0
• dicr/yii2-json: ~3.0
• dicr/yii2-validate: ~3.0
• yiisoft/yii2: ~2.0
• yiisoft/yii2-httpclient: ~2.0

Requires (Dev)

• phpunit/phpunit: ~9.5
• roave/security-advisories: dev-latest

Apache-2.0

• Igor Tarasov

• php
• yii2
• cdek
• dicr

README

Реализация JSON-протокола обмена данными СДЭК версии 1.5

Чтобы минимизировать число обращений к серверу СДЭК, запросы выполняются с кэшированием, параметры которого могут быть настроены в компоненте CdekApi который наследует CachingClient из пакета dicr/yii2-http.

Конфигурация

Компонент CdekApi настраивается в конфиге приложения.

return [
    'components' => [
        'cdek' => [
            'class' => dicr\cdek\CdekApi::class,
            // для тестирования используем тестовые url, логин и пароль
            'baseUrl' => dicr\cdek\CdekApi::URL_INTEGRATION_TEST,
            'login' => dicr\cdek\CdekApi::LOGIN_TEST,
            'password' => dicr\cdek\CdekApi::PASSWORD_TEST,
            // конфиг запроса стоимости доставки по-умолчанию
            'calcRequestConfig' => [
                // город отправителя у нас всегда один, поэтому пропишем его в конфиг по-умолчанию
                'senderCityPostCode' => 614087, // Пермь
                // здесь список тарифов, которые мы выбираем для доставки (можно настроить один в tariffId)
                'tariffList' => [
                    ['id' => dicr\cdek\CdekApi::TARIF_POST_S_S],
                    ['id' => dicr\cdek\CdekApi::TARIF_POST_S_D],
                    ['id' => dicr\cdek\CdekApi::TARIF_ECOPOST_S_D],
                    ['id' => dicr\cdek\CdekApi::TARIF_ECOPOST_S_S]
                ],
            ]   
       ]
    ]
];

Запросы к API

/** @var dicr\cdek\CdekApi $api */
$api = Yii::$app->get('cdek');

// запрос списка регионов
$regions = $api->regionRequest()->send();

// запрос списка городов
$cities = $api->cityRequest([
    'countryCode' => 'ru'
])->send();

// запрос списка пунктов самовывоза
$pvz = $api->cityRequest([
    'citypostcode' => 614087
])->send();

// расчет стоимости доставки (город отправителя и список тарифов заданы в конфиге компонента)
$result = $api->calcRequest([
    // город получателя можно либо код СДЭК, либо индекс в `receiverCityPostCode`
    'receiverCityId' => 44, // Москва,
     // из списка настроенных тарифов выбираем тарифы с доставкой от склада до двери
    'modeId' => dicr\cdek\CdekApi::DELIVERY_SKLAD_DOOR, 
    // характеристики посылок (у нас всего одна) 
    'goods' => [
        ['weight' => 0.24, 'volume' => 0.001]
    ]
])->send();

Пример настройки и запросов можно посмотреть в тестах phpunits (папка tests).

Детальная документация по параметрам запроса - в базе знаний СДЭК.