WT CDEK library

WT CDEK library

WT CDEK library

Небольшая нативная PHP Joomla библиотека для работы с API v.2 службы доставки CDEK. Пакет состоит из плагина для хранения настроек, PHP-библиотеки и виджета карты для выбора пунктов выдачи заказа. Библиотека представляет собой клиент для авторизации в CDEK API по OAuth, работы с некоторыми методами API: получения ряда данных и расчета стоимости доставки. Поддерживается Joomla 4.2.7 и выше.

  • Download type: Free
  • Категория: Библиотеки
  • Версия: 1.0.0
  • Скачивания : 291
  • Просмотры : 260

Описание

Внимание

Данное расширение предназначено для Joomla-разработчиков. Они могут использовать его в качестве зависимости при разработке своих расширений для Joomla.

Pull Requests welcome со стороны Joomla разработчиков!

В составе пакета

Библиотека представляет собой клиент для подключения к API CDEK и несколько методов для работы с ним с предварительной проверкой структуры данных, а также обработку ошибок при запросе. Для работы с библиотекой под рукой необходимо иметь официальную документацию CDEK API.

https://api-docs.cdek.ru

Подключение библиотеки в своё расширение для Joomla

<?php
use Webtolk\Cdekapi\Cdek;

defined('_JEXEC') or die('Restricted access');

$cdek = new Cdek();

// Индекс получателя
$index_to = 410012;

// Название населенного пункта
$city = 'Саратов';

// Массив параметров запроса к CDEK API
$cdek_city_options = ['size' => 1];

if (!empty($index_to))
{
	$cdek_city_options['postal_code'] = trim((string) $index_to);
}

if (!empty($city))
{
	$cdek_city_options['city'] = trim((string) $city);
}

$cdek_city = $cdek->getLocationCities($cdek_city_options);

Пример ответа

Array
(
    [0] => Array
        (
            [code] => 428
            [city_uuid] => 7e54a0b3-76f0-41e2-92e0-f1e600ad84fd
            [city] => Саратов
            [fias_guid] => bf465fda-7834-47d5-986b-ccdb584a85a6
            [country_code] => RU
            [country] => Россия
            [region] => Саратовская область
            [region_code] => 47
            [fias_region_guid] => df594e0e-a935-4664-9d26-0bae13f904fe
            [sub_region] => городской округ Саратов
            [longitude] => 46.034266
            [latitude] => 51.533562
            [time_zone] => Europe/Saratov
            [payment_limit] => -1
        )

)

Список методов библиотеки

getDeliveryPoints
Метод предназначен для получения списка действующих офисов СДЭК. Если одновременно указаны параметры city_code, postal_code, fias_guid, то для определения города всех стран присутствия СДЭК приоритет отдается city_code, затем fias_guid.
getLocationRegions
Список регионов. Метод предназначен для получения детальной информации о регионах. Список регионов может быть ограничен характеристиками, задаваемыми пользователем. В список параметров запроса не добавлены параметры, помеченные устаревшими.
getLocationCities
Список населенных пунктов. Метод предназначен для получения детальной информации о населенных пунктах. Список населенных пунктов может быть ограничен характеристиками, задаваемыми пользователем. В список параметров запроса не добавлены параметры, помеченные устаревшими.
getCalculatorTariff
Калькулятор. Расчет по коду тарифа. Метод используется для расчета стоимости и сроков доставки по коду тарифа.
getCalculatorTarifflist
Калькулятор. Расчет по всем доступным тарифам. Метод используется клиентами для расчета стоимости и сроков доставки по всем доступным тарифам.
subscribeToWebhook
Подписка на вебхуки (Webhooks). Методы предназначены для управления подпиской на получение вебхуков на URL клиента. Так как тестовый аккаунт СДЭК является общим для всех клиентов, для тестирования вебхуков необходимо использовать только боевой URL СДЭК. В запросе на добавление подписки укажите свой тестовый URL, куда будут приходить вебхуки. После завершения тестирования поменяйте его на свой боевой URL. Если у клиента уже есть подписка с указанным типом, то старый url перезаписывается новым.
createOrder
Запрос на регистрацию заказа.
getTariffListShop
Массив с тарифами CDEK для типа "интернет-магазин", актуальный на момент выхода версии библиотеки.
getTariffListDostavka
Массив с тарифами CDEK для типа "доставка", актуальный на момент выхода версии библиотеки.
Все методы принимают в качестве аргумента массив параметров запроса $request_options, структура которого должна соответствовать параметрам запроса документации CDEK API.

Официальный виджет выбора типа доставки от CDEK (выбор пунктов выдачи заказа на карте)

В состав библиотеки включен виджет последней на данный момент версии: 3.10.2.

cdek widget скриншот
cdek widget скриншот

 

Подключение JavaScript виджета CDEK

Javascript виджета оформлен как Joomla Web Asset. В своём коде подключаем его с помощью WebAssetManager следующим образом:

<?php
use Joomla\CMS\Factory;

defined('_JEXEC') or die('Restricted access');

$doc  = Factory::getApplication()->getDocument();

/** @var Joomla\CMS\WebAsset\WebAssetManager $wa */
$wa = $doc->getWebAssetManager();
$wa->useScript('cdek-widget-umd');

В остальном при настройке следуем документации виджета.

Service.php виджета

Виджет представляет собой Яндекс.карту, которая по ajax получает список пунктов выдачи заказа. Для работы с данной библиотекой нужно при инициализации виджета указать параметр servicePath - url для ajax-запроса. По умолчанию в комплекте с виджетом идёт файл service.php, который является точкой входа для ajax-запроса. В данной библиотеке функционал этого файла (получение списка ПВЗ и калькуляции тарифов) перенесён в системный плагин Joomla.

<?php
use Joomla\CMS\Uri\Uri;
use Joomla\CMS\Session\Session;

defined('_JEXEC') or die('Restricted access');

$service_url = new Uri(Uri::base());
$service_url->setPath('/index.php');
$service_url->setQuery([
    'option'                => 'com_ajax',
    'plugin'                => 'wtcdek',
    'group'                 => 'system',
    'format'               => 'raw',
    'city_code'          => $city_code, // CDEK код города для получения списка ПВЗ только для выбранного города
    Session::getFormToken() => 1
]);
// URL string
$service_url->toString();

Для javascript используем либо Joomla Script options, либо php echo, в зависимости от структуры вашего расширения.

Joomla

Тип расширения:
Пакет
Состав пакета:
Библиотека, Плагин
Версия Joomla:
4.2.7

Что нового

Первая версия расширения

Добавлено
Joomla 4.2.7+.

Расширения Joomla WebTolk

85 Всего расширений
11 Категорий
354 Выпущено версий
348916 Всего скачиваний
Корзина
Корзина пуста