Download the PHP package wildtuna/boxberry-sdk without Composer
On this page you can find all versions of the php package wildtuna/boxberry-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download wildtuna/boxberry-sdk
More information about wildtuna/boxberry-sdk
Files in wildtuna/boxberry-sdk
Package boxberry-sdk
Short Description SDK для работы с API BoxBerry (api.boxberry.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 boxberry-sdk
SDK для интеграции с программным комплексом Boxberry.
Посмотреть все проекты или подарить автору кофе можно тут.
Обратите внимание, что теперь у BoxBerry несколько API адресов:
- https://api.boxberry.de/json.php - для старых клиентов;
- https://api.boxberry.ru/json.php - для новых клиентов;
- https://account.boxberry.ru/json.php - для новых клиентов;
- https://api.boxberry.org - резервный адрес.
По умолчанию API выбирает api.boxberry.de, для смены адреса необходимо при инициализации клиента вторым параметром передать нужный адрес.
Пример:
Содержание
Changelog
Установка
Настройка токенов
Отладка
Создание/Редактирование заказа
Удаление/Отзыв заказа по номеру заказа магазина
Удаление/Отзыв заказа по трекномеру
Статусы заказа
Услуги в заказе
Список ПВЗ
Расчет тарифа
Полная информация о ПВЗ
Этикетка по заказу
Получить файл этикетки
Получить файл по ссылке
Получить список заказов по трек номеру или номеру заказа магазина
Информация о заказе по номеру заказа магазина
Информация о заказе по трекномеру
Список городов
Почтовые индексы с КД
Проверка почтового индекса
Список городов с КД
Список точек приема посылок
Список созданных заказов
Список доставляющихся заказов
Заявка на забор
Список заказов не добавленных в акт
Создание акта передачи посылок
Список созданных актов передачи посылок
Получить файл "Акта приема передачи посылки (АПП)" по номеру АПП
Получить файл акта ТМЦ (если подключена услуга в ЛК) по номеру АПП
Получить печатную форму этикеток по номеру АПП
- 0.8.9 - Добавлено поддержка country_code при получении списка ПВЗ
- 0.8.8 - Добавлены зависимости guzzle ^7.0 и psr/log ^2.0|^3.0
- 0.8.7 - Совместимость с Guzzle 7.4;
- 0.8.6 - Добавлен метод для получения списка заказов по трек номерам или по номерам заказа магазина. Доработкой занимался Maxim Rodionov;
- 0.8.5 - Добавлены методы для прямого получения печатных форм: акта, акта ТМЦ, этикеток по АПП. Доработкой занимался Maxim Rodionov;
- 0.8.4 - Добавлен метод получения этикетки. Спасибо Maxim Rodionov за доработку;
- 0.8.3 - Исправлен вызов методов поулчения информации о заказе. Спасибо Maxim Rodionov за доработку;
- 0.8.1 - Добавлены новые методы API. Подробнее тут. Спасибо Maxim Rodionov за доработку;
- 0.8.0 - Добавлена поддержка новый свойства в сущности Order и Place. Спасибо Maxim Rodionov за доработку;
- 0.7.8 - Совместимость с Guzzle 7.3;
- 0.7.7 - Совместимость с Guzzle 7.2;
- 0.7.6 - Совместимость с Guzzle 7.1;
- 0.7.5 - Совместимость с Guzzle 7;
- 0.7.4 - Исправлено добавление параметров для заказов Почты России. Спасибо Vasiliy за обнаружение и исправление;
- 0.7.3 - Обновлена зависимость с Guzzle;
- 0.7.2 - Исправлены опечатки и доделана совместимость с PHP 5.5/5.6. Спасибо Алексею за внимательность;
- 0.7.1 - Исправлена поломанная совместимость с PHP 5.5/5.6;
- 0.7.0 - Описание можно посмотреть тут;
- 0.6.2 - Поддержка разных адресов API;
- 0.6.1 - Доработка логирования;
- 0.6.0 - Добавлено логирование запросов и ответов к API;
- 0.5.1 - Понижена минимальная требуемая версия PHP до 5.5;
- 0.5.0 - Реализованы все функции API BoxBerry;
- 0.4.0 - Реализованы основные функции API справка API;
- 0.3.0 - Реализованы основные функции API сервисов BoxBerry.
Установка
Для установки можно использовать менеджер пакетов Composer
composer require wildtuna/boxberry-sdkНастройка токенов
API клиент позволяет использовать несколько токенов и переключатсья между ними.
При добавлении токенов последний добавленный становися выбранным.
Добавление токенов при инициализации: `
Переключение токенов:
`
Отладка
Для логирования запросов и ответов используется стандартный PSR-3 логгер.
Ниже приведен пример логирования используя Monolog.
В log.txt будут следующие строки:
Создание / Редактирование заказа
Создание нового заказа в ЛК BB. Заказы бывают двух видов, до ПВЗ и курьерская доставка до двери.
Если заказ в ПВЗ, то адрес доставки заполнять не требуется.
Подробнее можно прочитать тут, функция ParselCreate.
Входные параметры:
Объект \WildTuna\BoxberrySdk\Entity\Order
Выходные параметры:
Ассоциативный массив данных
Примеры вызова: `
Удаление/Отзыв заказа по номеру заказа магазина
Удаление/Отзыв заказа в ЛК BB, если он не проведен в акте.
Входные параметры:
- order_id (string) - номер ИМ
- cancelType (integer) - Вариант отмены заказа: 1- удалить посылку, 2- отозвать посылку. Если не передан, то по умолчанию 2 - отменить посылку в ЛК ИМ.
Выходные параметры:
(err) - false запрос успешно выполнен (в ЛК ИМ изменены данные посылки)
- string сообщение об ошибке, в случае err != false
Примеры вызова: `
Удаление/Отзыв заказа по трекномеру
Удаление/Отзыв заказа в ЛК BB, если он не проведен в акте.
Входные параметры:
- track (string) - номер ИМ
- cancelType (integer) - Вариант отмены заказа: 1- удалить посылку, 2- отозвать посылку. Если не передан, то по умолчанию 2 - отменить посылку в ЛК ИМ.
Выходные параметры:
(err) - false запрос успешно выполнен (в ЛК ИМ изменены данные посылки)
- string сообщение об ошибке, в случае err != false
Примеры вызова: `
Статусы заказа
Возвращает статусы заказа по трек-номеру BB или номеру заказа ИМ.
Входные параметры:
- order_id (string) - трек-номер / номер ИМ
- all (boolean) - true - полная информация, false - краткая информация (по умолчанию false)
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Услуги в заказе
Возвращает информацию о услугах по трек-номеру BB или номеру заказа ИМ.
Входные параметры:
- order_id (string) - трек-номер / номер ИМ
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Список ПВЗ
Для получения списка ПВЗ нужно использовать метод $bbClient->getPvzList.
Входные параметры:
- $prepaid (boolean) - false с возможностью оплаты при получении, true работающие с любым типом посылок (по умолчанию false)
- $short (boolean) - краткая информация о ПВЗ с датой последнего изменения (по умолчанию false)
- $city_code (integer) - позволяет выбрать ПВЗ только в заданном городе BoxBerry (по умолчанию null)
- $country_code (integer) - позволяет выбрать ПВЗ по странам (по умолчанию null)
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Расчет тарифа
Для расчета тарифа на доставку нужно использовать метод $bbClient->calcTariff.
Входные параметры:
Объект \WildTuna\BoxberrySdk\Entity\CalculateParams
Выходные параметры:
Объект \WildTuna\BoxberrySdk\Entity\TariffInfo
Примеры вызова:
Полная информация о ПВЗ
Для получения информации о ПВЗ нужно использовать метод $bbClient->pointDetails.
Если передан $photo=true, то в результирующем массиве будет ключ photos, который содержит массив фотографий в base64.
Входные параметры:
- $point_id (integer) - код ПВЗ
- $photo (boolean) - возврат фото ПВЗ (по умолчанию false)
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Этикетка по заказу
Позволяет получить ссылку на файл печати этикеток по определенной посылке.
Входные параметры:
- track (string) - трек-номер
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Получить файл этикетки
Позволяет сразу получить файл с этикеткой
Входные параметры:
- track (string) - трек-номер
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Получить файл по ссылке
Позволяет получить файл по ссылке. Боксберри отдает файлы этикетки, АПП, печатную форму акта, печатную форму акта ТМЦ в виде ссылок на скачивание.
Прямых методов на получение файлов у Боксберри нет, поэтому данный метод позволит обработать все существующие ссылки на печатные версии документов.
Входные параметры:
- link (string) - ссылка на документ
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Информация о заказе по номеру заказа магазина
Позволяет получить информацию о заказе по номеру заказа в магазине.
Входные параметры:
- order_id (string) - номер заказа в магазине
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Получить список заказов по трек номеру или номеру заказа магазина
Позволяет получить список заказов по трек номерам или номерам заказов в магазине, одним запросом.
Входные параметры:
- $order_ids (array) - массив трек номеров или номеров заказов магазина
- $parcel_type (string) - тип выборки (трек номер посылки или номер заказа магазина), принимает значения 'order_id' или 'track'. По умолчанию 'order_id'
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Информация о заказе по трекномеру
Позволяет получить информацию о заказе по трекномеру.
Входные параметры:
- track_id (string) - трекномер
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Список городов
Позволяет получить список городов, в которых есть пункты выдачи и список городов, в которых есть курьерская доставка.
Входные параметры:
- $all (boolean) - false - список городов, в которых есть ПВЗ, true список городов, в которых осуществляется доставка + в которых есть ПВЗ (по умолчанию false)
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Почтовые индексы с КД
Возвращает список почтовых индексов, для которых возможна курьерская доставка.
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Проверка почтового индекса
Проверка возможности курьерской доставки в заданном индексе.
Входные параметры:
- $index (integer) - Почтовый индекс
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Список городов с КД
Список городов, в которых осуществляется курьерская доставка.
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Список точек приема посылок
Список точек приема посылок.
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Список созданных заказов
Позволяет получить список созданных через API посылок.
Если не указывать диапазоны дат, то будет возвращен последний созданный заказ.
Выходные параметры:
- $from (string) - период от (дата в любом формате)
- $to (string) - период до (дата в любом формате)
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Список доставляющихся заказов
Получает информацию по заказам, которые фактически переданы на доставку в BoxBerry, но они еще не доставлены получателю.
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Заявка на забор
Создание заявки на забор заказов.
Входные параметры: Объект \WildTuna\BoxberrySdk\Entity\Intake - параметры заявки
Выходные параметры:
integer - номер заявки в системе BB
Примеры вызова:
Список заказов не добавленных в акт
Позволяет получить список всех трекинг кодов посылок которые есть в кабинете но не были сформированы в акт.
Входные параметры:
- $arr (bool) - true в виде массива, false в виде строки (по умолчанию false)
Выходные параметры:
array|string - массив трек-номеров или строка трек-номеров разделенная запятой
Примеры вызова:
Создание акта передачи посылок
Создание акта передачи посылок в BoxBerry.
Внимание! сервис работает только с заказами созданными через API ЛК.
Выходные параметры:
Массив трек-номеров заказов
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Список созданных актов передачи посылок
Позволяет получить список созданных через API актов передачи заказов.
Если не указывать диапазоны дат, то будет возвращен последний созданный акт.
Внимание! сервис работает только с актами созданными через API ЛК.
Выходные параметры:
- $from (string) - период от (дата в любом формате)
- $to (string) - период до (дата в любом формате)
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Получить файл "Акта приема передачи посылки (АПП)" по номеру АПП
Позволяет получить файл "Акта приема передачи посылки (АПП)" по номеру АПП
Входные параметры:
- $parcelId - номер АПП
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Получить файл акта ТМЦ (если подключена услуга в ЛК) по номеру АПП
Позволяет получить файл акта ТМЦ (если подключена услуга в ЛК) по номеру АПП
Входные параметры:
- $parcelId - номер АПП
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
Получить печатную форму этикеток по номеру АПП
Позволяет получить печатную форму этикеток по номеру АПП
Входные параметры:
- $parcelId - номер АПП
Выходные параметры:
Ассоциативный массив данных
Примеры вызова:
All versions of boxberry-sdk with dependencies
ext-json Version *
guzzlehttp/guzzle Version ^6.3|^7.0
psr/log Version ^1.0|^2.0|^3.0