Download the PHP package wildtuna/iml-sdk without Composer
On this page you can find all versions of the php package wildtuna/iml-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download wildtuna/iml-sdk
More information about wildtuna/iml-sdk
Files in wildtuna/iml-sdk
Package iml-sdk
Short Description SDK для работы с API IML delivery (api.iml.ru)
License MIT
Informations about the package iml-sdk
Компания IML закрыта. Проект переведен в архив.
SDK для интеграции с программным комплексом IML.
Посмотреть все проекты или подарить автору кофе можно тут.
Содержание
- Changelog
- Установка
- Настройка аутентификации
- Отладка
- API интеграции с IML
- Создание заказа
- Получить состояние заказа (статус)
- Список заказов
- Печать этикетки
- Справочный сервис IML
- Справочник ограниченных ресурсов
- Справочник почтовых индексов
- Детальная информация по почтовому индексу
- Справочник складов
- Справочник регионов, где возможен самовывоз
- Справочник почтовых ограничений
- Справочник регионов IML
- Справочник пунктов самовывоза (ПВЗ)
- Список ПВЗ в указанном регионе
- Список ПВЗ по коду КЛАДР
- Все справочники одним запросом
- Справочник услуг
- Справочник статусов
- Справочник сегментов маршрутов
- Получение данных сегмента маршрута по коду
- Справочник дополнительных зон доставки
- Список заблокированных регионов IML
- Справочник валют оценочной стоимости
- Рабочий календарь IML
- Справочник регионов и городов доставки
- Справочник тарифных зон Почты России
- Справочник единиц измерения вложений заказа
- Справочник зон доставки
- 0.6.8 - Добавлены зависимости guzzle ^7.0 и psr/log ^2.0|^3.0
- 0.6.7 - Совместимость с Guzzle 7.4;
- 0.6.6 - Совместимость с Guzzle 7.3;
- 0.6.5 - Совместимость с Guzzle 7.2;
- 0.6.4 - Совместимость с Guzzle 7.1;
- 0.6.3 - Совместимость с Guzzle 7;
- 0.6.2 - Обновлена зависимость Guzzle;
- 0.6.1 - Доработка логирования;
- 0.6.0 - Добавлено логирование запросов и ответов к API;
- 0.5.0 - Реализованы функции https://api.iml.ru;
- 0.4.0 - Реализованы функции https://list.iml.ru, добавлено описание;
- 0.3.0 - Реализована часть функций https://list.iml.ru;
- 0.2.0 - Созданы сущности для работы с заказом и механизм смены учетных данных;
- 0.1.0 - Cкелет SDK;
Установка
Для установки можно использовать менеджер пакетов Composer
composer require wildtuna/iml-sdk
- API_IML - API интеграции https://api.iml.ru;
- LIST_IML - Справочный сервис IML https://list.iml.ru;
- УЗ - учетная запись;
- ИМ - интернет-манагиз;
- ПВЗ - пункт выдачи заказов;
- БД - база данных (СУБД);
- ОФД - оператор фискальных данных;
- ФФД - формат фискальных документов;
- EAN-13 - формат штрих-кода.
Настройка аутентификации
API клиент позволяет использовать несколько учетных записей IML и переключатьcя между ними.
При добавлении учетных записей последняя добавленная становися выбранной.
Добавление УЗ при инициализации: `
Переключение УЗ:
`
Отладка
Для логирования запросов и ответов используется стандартный PSR-3 логгер.
Ниже приведен пример логирования используя Monolog.
Запрос и ответ будут в файле log.txt.
API интеграции с IML
Функции основного API компании IML (Работа с заказами и этикетками).
Создание заказа
Создание нового заказа в IML. Подробное описание свойств объекта \WildTuna\ImlSdk\Entity\Order() можно посмотреть тут.
Описание порядка заполнения полей можно посмотреть тут.
Входные параметры:
Объект \WildTuna\ImlSdk\Entity\Order
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Получить состояние заказа (статус)
Возвращает детальную информацию о состояние заказа с списком вложения.
Входные параметры:
$order_id (string) - номер заказа ИМ (не IML)
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Список заказов
Возвращает список заказов за указанный период дат.
Входные параметры:
$from (string) - период от (дата в любом формате)
$to (string) - период до (дата в любом формате)
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Печать этикетки
Возвращает ссылку на PDF-файл или PNG картинку с этикетами заказа.
Входные параметры:
$barcode (string) - штрих код заказа в формате EAN-13. Существует возможность принимать несколько штрих кодов через разделитель '|' без пробелов.
Выходные параметры:
Ссылка на PDF-файл или PNG картинку
Примеры вызова:
Справочный сервис IML
Функции API справочников компании IML (Получение ПВЗ, услуг, городов и т.п.).
Справочник ограниченных ресурсов
Возвращает список ограниченных ресурсов.
Входные параметры:
Отсутствуют
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Справочник почтовых индексов
Возвращает список почтовых индексов.
Входные параметры:
Отсутствуют
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Детальная информация по почтовому индексу
Возвращает детальную информацию о почтовом индексе.
Входные параметры:
- $zip (int) - Почтовый индекс
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Справочник складов
Возвращает детальную информацию о почтовом индексе.
Входные параметры:
- $full (boolean) - флаг расширенной информации по складам
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Справочник регионов, где возможен самовывоз
Возвращает список регионов, где возможен самовывоз (есть ПВЗ).
Входные параметры:
Отсутствуют
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Справочник почтовых ограничений
Возвращает список ограничений заказов отправляемых через Почту России.
Входные параметры:
Отсутствуют
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Справочник регионов IML
Возвращает список регионов IML.
Входные параметры:
Отсутствуют
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Справочник пунктов самовывоза (ПВЗ)
Возвращает список пунктов выдачи заказов.
Входные параметры:
Отсутствуют
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Список ПВЗ в указанном регионе
Возвращает список пунктов выдачи заказов в указанном регионе (см. справочник регионов)
Входные параметры:
- $region_code (string) - Код региона из справочника регионов
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Список ПВЗ по коду КЛАДР
Возвращает список пунктов выдачи заказов по коду КЛАДР.
Входные параметры:
- $kladr (string) - Код КЛАДР
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Все справочники одним запросом
Возвращает все справочники одним запросом. Порядок справочников можно посмотреть тут.
Обратите внимание, что в описании ключи справочников строковые, по факту числовые, но порядок совпадает.
Входные параметры:
Отсутствуют
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Справочник услуг
Возвращает список услуг.
Входные параметры:
Отсутствуют
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Справочник статусов
Возвращает список услуг.
Входные параметры:
Отсутствуют
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Справочник дополнительных зон доставки
Возвращает список дополнительных зон доставки.
Входные параметры:
Отсутствуют
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Справочник валют оценочной стоимости
Возвращает список валют.
Входные параметры:
Отсутствуют
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Рабочий календарь IML
Возвращает рабочий календарь IML.
Входные параметры:
Отсутствуют
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Справочник регионов и городов доставки
Возвращает список регионов и городов доставки.
Входные параметры:
Отсутствуют
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Справочник тарифных зон Почты России
Возвращает список тарифных зон Почты России.
Входные параметры:
Отсутствуют
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Справочник единиц измерения вложений заказа
Возвращает список единиц измерения вложений заказа.
Входные параметры:
Отсутствуют
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Справочник сегментов маршрутов
Возвращает список сегментов маршрутов.
Входные параметры:
Отсутствуют
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Получение данных сегмента маршрута по коду
Возвращает список сегментов маршрутов.
Входные параметры:
$segment_code (string) - код сегмента
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Список заблокированных регионов IML
Список заблокированных регионов IML в разрезе услуг.
Входные параметры:
Отсутствуют
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Справочник зон доставки
Список зон доставки с указанием количества дней.
Входные параметры:
Отсутствуют
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
All versions of iml-sdk with dependencies
ext-json Version *
guzzlehttp/guzzle Version ^6.3|^7.0
psr/log Version ^1.0|^2.0|^3.0