Download the PHP package justcommunication-ru/outofbox-ru-api-php-sdk without Composer
On this page you can find all versions of the php package justcommunication-ru/outofbox-ru-api-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download justcommunication-ru/outofbox-ru-api-php-sdk
More information about justcommunication-ru/outofbox-ru-api-php-sdk
Files in justcommunication-ru/outofbox-ru-api-php-sdk
Package outofbox-ru-api-php-sdk
Short Description Outofbox.ru API PHP SDK
License MIT
Informations about the package outofbox-ru-api-php-sdk
Outofbox.ru API PHP SDK
PHP SDK для сайтов и интернет-магазинов на платформе outofbox.ru
- Установка
- Использование
- Методы
- Токен авторизации
- Список позиций каталога
- Просмотр позиции каталога
- Список категорий товаров
- Список филиалов
- Заказы/Заявки
- Создание заказа/заявки
- Информация о заказе/заявке
- Обработка ошибок
- Настройка HTTP клиента
- Логирование
- Тесты
Установка
composer require justcommunication-ru/outofbox-ru-api-php-sdk
Использование
https://domain.ru
– домен вашего сайта на платформе outofbox.ru
email
— имя пользователя или email. Уровень доступа аккаунта должен быть не менее Сотрудник
token
— аутентификационный токен
Методы
Токен авторизации
Данный метод поможет получить токен авторизации пользователя по его паролю. Токен не ограничен во времени и может поменяться только в случае смены пароля пользователя.
$password
– пароль пользователя
Внимание! Данный метод не предназначен для запроса на боевом окружении! Предполагается, что если вам не известен токен пользователя, то необходимо его запросить и далее работать исключительно с токеном авторизации. Не храните пароль пользователя в открытых источниках!
Если существует риск утечки токена, то рекомендуется поменять пароль пользователя и запросить токен еще раз.
Список позиций каталога
Наличие на складах (Если подключен Outofbox.Склад)
Просмотр позиции каталога
Список категорий товаров
Верхний уровень категорий:
Подкатегории:
или
Важно! Данный метод не подходит для выбора всего дерева подкатегорий рекурсивными вызовами! Вместо этого надо использовать метод, который может вернуть сразу все дерево (@todo)
Список филиалов
Заказы/Заявки
- Создание заказа/заявки
- Информация о заказе/заявке
Создание заказа/заявки
@todo: описать все доступные поля заказа (адреса доставки, данные клиента и т. д.)
Информация о заказе/заявке
Обработка ошибок
При ошибке будет сгенерировано исключение OutofboxAPIException
Настройка HTTP клиента
Способ №1: передача массива параметров
Список доступных параметров: https://docs.guzzlephp.org/en/stable/request-options.html
Способ №2: передача своего \GuzzleHttp\Client
Настройте своего http клиента:
и передайте его аргументом конструктора:
либо сеттером:
Логирование
В $client
можно передать свой Psr\Logger
.
По-умолчанию, логирование отключено.
All versions of outofbox-ru-api-php-sdk with dependencies
guzzlehttp/guzzle Version ^6.2|^7.0
symfony/serializer Version *
symfony/property-access Version *
symfony/property-info Version *
ext-json Version *