Download the PHP package chessterrdev/ozonrocket-sdk without Composer
On this page you can find all versions of the php package chessterrdev/ozonrocket-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
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 ozonrocket-sdk
Ozon Logistics (Ozon:Rocket)
Работа с боевым API возможна только при наличии договора с Ozon
Список возможностей и содержание SDK:
Начало работы (авторизация)
Доставка
- [X] Получить способы доставки
- [X] Получить способы доставки по адресу
- [X] Получить способы доставки по viewport
- [X] Получить способы доставки по идентификаторам
- [X] Получить идентификаторы способов доставки
- [X] Получить список городов с доступными способами доставки
- [X] Рассчитать стоимости доставки
- [X] Рассчитать объёмный вес
- [X] Рассчитать стоимость и срок доставки по адресу
- [X] Получить место передачи отправлений DropOff на склад
- [X] Получить информацию о складе возврата
- [X] Получить информацию о сроках доставки
- [X] Получить список складов пикапа
В разработке:
- Заказы
- Отгрузка
- Трекинг
- Накладные
- Отчёты
- Акты
- Тарифы
- Этикетки
Требования
Автор старался сделать наиболее функциональный и универсальный SDK. Необходимы: PHP 7.4 и выше, расширение "ext-json", и клиент Guzzlehttp.
Установка
Установка осуществляется с помощью менеджера пакетов Composer
Документация
Пригодится справочная информация по Ozon Rocket API (1.0.0)
Руководство к действию
Начало работы
Авторизация
Для интеграции с OzonRocket по протоколу обмена данными необходимо:
Заключить договор с OzonRocket и получить пару ключей client_id + client_secret в личном кабинете в разделе Настройки → Интеграция API. Для безопасности не рекомендуем вносить ключи в какую-либо базу данных.
Данный программный комплекс поддерживает как тестовую, так и боевую (полнофункциональную) среду.
Для того, чтобы воспользоваться Тестовой средой, нужно в первом аргументе передать 'TEST'. Все необходимые настройки SDK загрузит автоматически.
Полнофункциональная "боевая" авторизация осуществляется с использованием пары ключей client_id + client_secret для api. Опционально можно устанавливать таймаут соединения 3 аргументом $timeout (по умолчанию 5.0), как на тестовом, так и на боевом аккаунте.
После успешной авторизации сервер выдает токен, срок действия токена по умолчанию 3600 секунд. Сохранять не обязательно, вы можете авторизироваться каждый раз заново. Сохранив в сессии или в файле этот токен, вы избавите себя от повторной авторизации на указанный срок.
Cохранение токена
Чтобы SDK сохраняла токен в сессии, нужно в файле настроек (\OzonRocketSDK\Client\Constants) у константы SAVE_SESSION установить значение true.
Так же, если сессия не была открыта ранее, её нужно открыть:
Далее, SDK будет контролировать время жизни токена и обновлять его по надобности, независимо от среды (тестовой или боевой). Например, если вы пользовались тестовой средой и после решили перейти на боевую, SDK автоматически авторизуется заново и сохранит новый токен.
Информация о доступных геттерах и сеттерах SDK
Каждый метод геттер и сеттер соответствует одноименному свойству ответа сервера Ozon в camel case (Верблюжий регистре). Если свойство сложное, например, Package, Dimensions, GeoCoordinates, то у него как правило есть объект ответа sdk Package, Dimensions, GeoCoordinates и т.п. Соответственно обратившись к этому свойству через геттер вы получите объект данного класса.
Доставка
Получить способы доставки
/v1/delivery/variants
Получить способы доставки по адресу
/v1/delivery/variants/byaddress
Получить способы доставки по viewport
/v1/delivery/variants/byviewport
Рекомендуем использовать метод для интегрирования виджета карты на сайт.
Получить способы доставки по идентификаторам
/v1/delivery/variants/byids
Метод для получения списка способов доставки по идентификаторам способов доставки.
Получить идентификаторы способов доставки
/v1/delivery/variants/byaddress/short
Метод для получения идентификаторов способов доставки по указанному адресу.
Получить список городов с доступными способами доставки
/v1/delivery/cities/extended
Рассчитать стоимости доставки
/v1/delivery/calculate
Рассчитать объёмный вес
/v1/delivery/calculate/materialWeight
Рассчитать стоимость и срок доставки по адресу
/v1/delivery/calculate/information
Метод для рассчёта стоимости и срока доставки по адресу с учётом объёмного веса.
