Download the PHP package fsdelivery/fsdelivery-php-sdk without Composer
On this page you can find all versions of the php package fsdelivery/fsdelivery-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download fsdelivery/fsdelivery-php-sdk
More information about fsdelivery/fsdelivery-php-sdk
Files in fsdelivery/fsdelivery-php-sdk
Package fsdelivery-php-sdk
Short Description Полная SDK агрегатора служб доставки FsDelivery.ru
License MIT
Informations about the package fsdelivery-php-sdk
SDK для интеграции с программным комплексом FsDelivery.
Документация к API.
Содержание
Changelog
Установка
Отладка
Расчет тарифа
Получение списка служб доставки
Получение списка режимов доставки
Получение списка тарифов
Получение списка возможных статусов заказа
Получение списка стран
Получение списка городов
Получение списка городов для AUTOCOMPLETE
Получение списка пунктов выдачи заказов (ПВЗ)
Детализация по реестру НП
Возможные статусы реестров НП
Список реестров НП
Получение информации о пользователе
Получение статусов заказа
Получение информации по заказам
- 0.6.1 - Добавляет поддержку Guzzle 7.*
- 0.6.0 - Подробное описание можно посмотреть здесь;
- 0.5.0 - Первая версия SDK реализующая методы API FsDelivery;
Установка
Для установки можно использовать менеджер пакетов Composer
composer require fsdelivery/fsdelivery-php-sdk
Или при его отсутствии можно использовать встройенный autoload.php.
Тогда подключение SDK будет выглядеть так:
Если в вашей системе установлен Http-клиент Guzzle, то для запросов к API будет использоваться он.
При его отсутствии будет задействован встроенный HttpClient.
Отладка
Для логирования запросов и ответов используется стандартный PSR-3 логгер.
Ниже приведен пример логирования используя Monolog.
Или можно использовать встроенный в SDK Logger, который умеет писать в текстовые файлы
В log.txt будут логи в виде:
Для расчета стоимости доставки используйте метод calculateTariff.
Входные параметры:
- $calcParams - объект FsDeliverySdk\ValueObject\CalculateParams;
Выходные параметры:
- array - список тарифов по заданным параметрам расчета
Примеры вызова:
Получение списка служб доставки
Для получения доступных служб доставки используйте метод getDeliveryList.
Входные параметры: Отсутствуют
Выходные параметры:
- array - Список служб доставки
Примеры вызова:
Получение списка режимов доставки
Для получения списка режимов доставки используйте метод getDeliveryTypes.
Входные параметры:
- int $type_id - ID режима доставки по базе FsDelivery (не обязательный параметр)
Выходные параметры:
- array - список режимов доставки
Примеры вызова:
Для расчета стоимости доставки используйте метод calculateTariff.
Входные параметры: int $delivery_id - ID службы доставки по базе FsDelivery (не обязательный параметр) int $type_id - ID режима доставки по базе FsDelivery (не обязательный параметр)
Выходные параметры:
- array - список тарифов
Примеры вызова:
Получение списка возможных статусов заказа
Для получения списка всех возможных статусов заказа используйте метод getDeliveryStatuses.
Входные параметры: Отсутствуют
Выходные параметры:
- array - список статусов с разбивкой по службам доставки
Примеры вызова:
Для получение списка стран используйте метод getReferenceCountries.
Входные параметры:
- int $country_id - ID страны по базе FsDelivery
- string $country_code - Код страны (ISO 3166-1 2 буквы)
- string $country_name - Точное название страны (например Россия), поиск без учета регистра
Выходные параметры:
- array - список стран
Примеры вызова:
Для получение списка городов используйте метод getReferenceCities.
Входные параметры:
- CitiesFilter $searchFilter - объект-фильтр
- int $page_number - Номер страницы для выборки
- int $page_size - Количество результатов на странице
Выходные параметры:
- array - список городов
Примеры вызова:
Получение списка городов для AUTOCOMPLETE
Для получение списка городов для AUTOCOMPLETE используйте метод getReferenceCitiesAutocomplete.
Входные параметры:
- string $char_city_name - Строка поиска по названию города (от двух символов)
- int|null $fsdelivery_country_id - ID страны по базе FSDelivery
Выходные параметры:
- array - список городов
Примеры вызова:
Получение списка пунктов выдачи заказов (ПВЗ)
Для получение списка пунктов выдачи заказов (ПВЗ) используйте метод getDeliveryPoints.
Входные параметры:
- PvzFilter $pvzFilter - объект-фильтр
Выходные параметры:
- array - список ПВЗ
Примеры вызова:
Для получения детализации по реестру НП используйте метод getReestrWaybills.
Входные параметры:
- int $reestr_number - Номер реестра наложенного платежа (поле number из метода /1.0/reestr/list)
Выходные параметры:
- array - список данных
Примеры вызова:
Для получения возможных статусов реестров НП используйте метод getReestrStatuses.
Входные параметры: Отсутствуют
Выходные параметры:
- array - список статусов
Примеры вызова:
Для получения списка реестров НП используйте метод getReestrList.
Входные параметры:
- ReestrFilter $reestrFilter - объект-фильтр
Выходные параметры:
- array - список реестров
Примеры вызова:
Получение информации о пользователе
Для получение информации о пользователе используйте метод getUserInfo.
Входные параметры: Отсутствуют
Выходные параметры:
- array - информация о пользователе
Примеры вызова:
Для получение статусов заказа используйте метод $orderStatusFilter.
Входные параметры:
- OrderStatusFilter $orderStatusFilter - объект-фильтр
Выходные параметры:
- array - список статусов
Примеры вызова:
Получение информации по заказам
Для получение информации по заказам используйте метод ****.
Входные параметры:
- OrderFilter $orderFilter - объект-фильтр
Выходные параметры:
- array - список заказов
Примеры вызова:
All versions of fsdelivery-php-sdk with dependencies
ext-curl Version *
php Version >=7.0
guzzlehttp/guzzle Version ^6.3|^7.0
monolog/monolog Version ^2.3