Download the PHP package kex15i10/ukrposhta without Composer
On this page you can find all versions of the php package kex15i10/ukrposhta. 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 ukrposhta
Ukrposhta
Ukrposhta - это библиотека для работы с API УкрПошты, далее УП. В данном проекте реализована работа с:
- Справочники - список адресов в которых работают отделения УП, а именно области, регионы, города, отделения и улицы.
- Клиенты - работа с контрагентами(создание, редактирование). Клиенты используются при создании отправок.
- Адреса - работа с адресами клинта(создание, редактирование). Адреса привязываются к клиентам и используются при создании отправок.
- Отправки - работа с почтовыми отправлениями(создание, редактирование, отслеживание статуса).
- Формы - получение формы отправки(накладной) в формате pdf.
- Документацией - получение последней актуальной документации по API.
Установка
git
composer
Использование
Конфигурация
Каждый класс принимает в качестве аргумента конструктора объект-конфигурацию: Ukrposhta\Data\Configuration. В данном классе устанавливаем token и bearer при помощи соответствующих методов-сеттеров
Так же в данном классе можно добавить заголовки для запросов при помощи соответствующего метода
Общая Документация
API
Актуальную документацию по параметрам API и возвращаемым полям можно получить на официальном сайте или воспольоваться классом данной библитеки
Метод save принимает два аргумента. Первый является обязательным - это путь для сохранения файла, второй, не обязательный, это имя сохраняемого файла, по-умолчанию "documentation.pdf".
Возвращаемые данные, Исключения(Exceptions)
В случае когда API должен вернуть данные(например при работе со справочниками, с.м. документацию к API) - будет возвращен массив данных. Когда происходит ошибка, будь то серверная либо ошибка API - библиотека бросит исключение (Exception) в соответствии с поведением библиотеки для HTTP запросов GuzzleHttp\Client.
Параметры запросов
В случае, когда необходимо передавать параметры в запросе, метод соответствующего класса в качестве параметра принимает объект класса Ukrposhta\Data\Storage. Конструктор данного класса(Storage) принимает необзательный аргумент в ввиде массива с параметрами в формате ключ-значение. Указать данные можно несколькоми способами:
Работа со справочниками
Работа со справочниками представлена следующими классами
- Ukrposhta\Directory\City
- Ukrposhta\Directory\District
- Ukrposhta\Directory\Postoffice
- Ukrposhta\Directory\Region
- Ukrposhta\Directory\Street
Для получения списка городов, областей, регионов и улиц есть метод getList для соответствующих классов
Для получения списка городов с фильтром по региону
Получение списка отеделений по id города
Получение отделения по почтовому индексу
Адреса, Контрагенты, Отправления
Работа с данными моделями реализована в следующих классах
- Ukrposhta\Address
- Ukrposhta\Client
- Ukrposhta\Shipment
Для создания адреса контрагента, самого контрагента и отправления необходимо воспользоваться методом save соответсвующего класса. Данный метод первым аргументом принимает объект класса Ukrposhta\Data\Storage с параметрами запроса.\ Пример создания контрагента
Для обновления информации о контрагенте необходимо в методе save вторым аргументом указать UUID контрагента
Для получения информации о клиенте необходимо воспользоваться методом get
Данный метод принимает первым аргументом идентифкатор клиента, по-умолчанию это UUID контрагента. Если указать второй параметр true, то в этом случае первый аргумент будет выступать как external-id
Печать накладных
Для работы с накладным есть класс Ukrposhta\Form с методом saveSticker
Данный метод принимает два обязательных аргумента, первый - идентификатор отправления(UUID отправления или barcode), второй - путь сохранения файла. Третий аргумент - это название сохраняемого файла, по-умолчанию "sticker.pdf". Четверый - список параметров передваемых в запросе в виде объекта класса Ukrposhta\Data\Storage.
