Download the PHP package lapaygroup/metaship-sdk without Composer
On this page you can find all versions of the php package lapaygroup/metaship-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download lapaygroup/metaship-sdk
More information about lapaygroup/metaship-sdk
Files in lapaygroup/metaship-sdk
Package metaship-sdk
Short Description SDK для работы с API V2 агрегатора MetaShip (https://metaship.ru)
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package metaship-sdk
SDK для интеграции с программным комплексом MetaShip API V2.
[!IMPORTANT] Неофициальный независимый проект
Этот проект не является официальным SDK MetaShip, не связан с сервисом MetaShip, не поддерживается, не одобрен и не спонсируется правообладателем.
Обозначение «MetaShip» используется исключительно для указания совместимости SDK с API соответствующего сервиса. Все права на товарный знак «MetaShip» принадлежат его правообладателю.
Unofficial independent project
This is not an official MetaShip SDK. The project is not affiliated with, maintained, endorsed, or sponsored by MetaShip or the trademark owner. The “MetaShip” name is used solely to identify API compatibility.
Посмотреть все проекты или подарить автору кофе можно тут.
Документация к API V2 MetaShip.
Содержание
- Changelog
- Конфигурация
- Отладка
- Расчет офферов (тарифы)
- Список точек выдачи
- Склады
- [x] Создание склада
- [x] Список складов
- [x] Информация о складе
- [ ] Обновление склада
- [x] Удаление склада
- Магазины
- [x] Создание магазина
- [x] Список магазинов
- [ ] Информация о магазине
- [ ] Обновление магазина
- [ ] Удаление магазина
- Заказы
- [x] Создание заказа
- [ ] Список заказов
- [x] Информация о заказе
- [x] Удаление заказа
- [ ] Редактирование заказа
- [x] История статусов заказа
- [x] Подробной информации о заказе
- Партии
- [x] Создание партии
- [x] Список партий
- [x] Информация о партии
- [ ] Обновление партии
- Документы
- [x] Получение этикетки заказа
- [x] Получение этикеток заказов из партии
- [x] Получение АПП
- 0.5.1 - Добавляет параметр options в метод getPvzList;
- 0.5.0 - Добавляет параметр shop_id в метод getPvzList;
- 0.4.6 - Добавлены зависимости guzzle ^7.0 и psr/log ^2.0|^3.0;
- 0.4.5 - В OrderStatusHelper добавлен справочник наименований статусов MetaShip;
- 0.4.4 - Исправлена ошибка возврата пустого массива от API;
- 0.4.3 - Добавлено преобразование типов у объектов Order и Item;
- 0.4.2 - В JwtSaveFileHelper добавлена возможность задать свой путь к файлу при инициализации;
- 0.4.1 - Добавлено новое исключение MetaShipValidationException для обработки 400-х ошибок API;
- 0.4.0 - Добавлена методы для работа с партиями и документами;
- 0.3.0 - Подробное описание тут;
- 0.2.1 - Добавлен метод получения статусов заказа, добавлен OrderStatusHelper;
- 0.2.0 - Первая Alfa-версия SDK.
Установка
Для установки можно использовать менеджер пакетов Composer
composer require lapaygroup/metaship-sdkДля работы с API необходимо получить токен и секретный ключ. Найти их можно в личном кабинете в разделе "Интеграция". С этими данными необходимо получить токен доступа в формате JWT и сохранить его. Токен живет 1 час с момента издания.
SDK позволяет сохранять JWT, для этого необходимо использовать Helper, который должен реализовывать JwtSaveInterface. В SDK встроен Helper для сохранения токена в временный файл JwtSaveFileHelper. Если Helper не передан в конструктор клиента, будет использоваться JwtSaveFileHelper.
Отладка
Для логирования запросов и ответов используется стандартный PSR-3 логгер.
Ниже приведен пример логирования используя Monolog.
В log.txt будут логи в виде:
Для расчета стоимости доставки используйте метод getOffers. Он возвращает по заданным параметрам
Входные параметры:
- $offerParams - Параметры для расчета, объект LapayGroup\MetaShipSdk\Entity\OfferParams;
Выходные параметры:
- array - доступные тарифы по подключенным СД;
Примеры вызова:
Список точек выдачи
Метод getPvzList возвращает список постаматов и пунктов выдачи заказов конкретной СД или в городе по всем СД.
Должен быть передан один из параметров.
Входные параметры: = , = null
- string|null $delivery_code - Код СД;
- string|null $city_name - Название города.
Выходные параметры:
- array - Список точек выдачи по заданному фильтру.
Примеры вызова:
Склады
Список методов для работы с складами MetaShip.
Создание склада
Метод createWarehouse позволяет добавить склад забора заказов.
Входные параметры:
- Warehouse - Параметры склада, объект LapayGroup\MetaShipSdk\Entity\Warehouse.
Выходные параметры:
- array - Результат создания склада
Примеры вызова:
Список складов
Метод getWarehouses возвращает список созданных складов.
Выходные параметры:
- array - список складов
Примеры вызова:
Получение склада
Метод getWarehouse возвращает данные склада
Входные параметры:
- string warehouse_id - uuid склада в системе MetaShip.
Выходные параметры:
- array - данные склада
Примеры вызова:
Удаление склада
Метод deleteWarehouse удаляет склад.
Входные параметры:
- string warehouse_id - uuid склада в системе MetaShip.
Выходные параметры:
- boolean - при успешном удалении true
Примеры вызова:
Магазины
Список методов для работы с магазинами MetaShip.
Создание магазина
Метод createShop позволяет создать магазин.
Входные параметры:
- string $shop_name - название магазина;
- string $shop_uri - uri-адрес магазина;
Выходные параметры:
- array - данные созданного магазина
Примеры вызова:
Список магазинов
Метод getShops позволяет получить список созданных магазинов.
Выходные параметры:
- array - данные созданного магазина
Примеры вызова:
Заказы
Список методов для работы с заказами MetaShip.
Создание заказа
Метод getWarehouses
Входные параметры:
- Order - Параметры заказа, объект LapayGroup\MetaShipSdk\Entity\Order.
Выходные параметры:
- array - данные созданного заказа
Примеры вызова:
Информация о заказе
Метод getOrderInfo возвращает информацию о заказе
Входные параметры:
- string order_id - uuid заказа в системе MetaShip.
Выходные параметры:
- array - данные заказа
Примеры вызова:
Удаление заказа
Метод deleteOrder удаляет заказ.
Входные параметры:
- string order_id - uuid заказа в системе MetaShip.
Выходные параметры:
- boolean - при успешном удалении true
Примеры вызова:
История статусов заказа
Метод getOrderStatuses возвращает список статусов заказа
Входные параметры:
- string order_id - uuid заказа в системе MetaShip.
Выходные параметры:
- array - список статусов
Примеры вызова:
Подробная информации о заказе
Метод getOrderDetails возвращает подробную информации о заказе.
Входные параметры:
- string order_id - uuid заказа в системе MetaShip.
Выходные параметры:
- array - данные о заказе
Примеры вызова:
Партии
Список методов для работы с партиями MetaShip.
Создание партии
Метод getOrderDetails возвращает подробную информации о заказе.
Входные параметры:
- string order_id - uuid заказа в системе MetaShip.
Выходные параметры:
- array - данные о заказе
Примеры вызова:
Документы
Список методов для работы с документами MetaShip.
Получение АПП
Метод getParcelAcceptance возвращает акт приема передачи.
Входные параметры:
- string order_id - uuid заказа в системе MetaShip.
Выходные параметры:
- GuzzleHttp\Psr7\UploadedFile - АПП в формате PDF
Примеры вызова:
Прочее
Прочая информация.
Получение интервалов доставки
Метод getDeliveryTimeSchedules интервалов доставки в зависимости от переданной КС.
Реализовано для следующих Служб доставки:
– TopDelivery
– Boxberry
– Dalli
– СДЭК
Входные параметры: = , = null
- string|null $delivery_code - Код СД;
- array $options - параметры для конкретной КС.
Выходные параметры:
- array - Список интервалов доставки.
Примеры вызова:
All versions of metaship-sdk with dependencies
ext-json Version *
guzzlehttp/guzzle Version ^6.3|^7.0
psr/log Version ^1.0|^2.0|^3.0