Download the PHP package dou-xx/nova-poshta without Composer
On this page you can find all versions of the php package dou-xx/nova-poshta. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package nova-poshta
Nova Poshta
PHP библиотека для работы с API Новой Почты
Основные возможности:
- Получение данных и контакт отправителя
- Создание/Получение данных и контакт получателя (Физ. и Юр. лицо)
- Создание адреса получателя
- Создание накладной (ТТН)
- Трекинг ТТН
Установка
composer require dou-xx/nova-poshta
Примеры кода:
Важно! Для работы нужен Api Key Новой Почты
Получение отправителя:
Класс GetSenderRequest
Результат - объект класса ResponseContract
Из примера выше видно, что $response имеет свои методы для получения данных
$response->isSuccess()
- возвращает bool (true или false), и говорит об успешности запроса в целом
$response->getData()
- получить весь массив данных ответа Новой Почты
$response->getItem()
- может принимать 2 параметра:
- Первый это ключ в массиве полученных данных
- Второй это номер элемента (индекс) полученного массива. В ответе на запрос контактов отправителя элементов может быть несколько.
Примеры:
$response->getItem('Ref')
- Получить значение Ref из первого элемента
$response->getItem('Ref', 1)
- Получить значение Ref из второго элемента
$response->getItem()
- Получить весь массив данных первого элемента
$response->getItem(null, 1)
- Получить весь массив данных второго элемента
Получить контакт отправителя:
Класс GetCounterPartyContactsRequest
Результат - объект класса ResponseContract
Создать получателя (Физ-лицо):
Класс CreateCounterPartyRequest
Результат - объект класса CounterPartyResponse
Этот запрос создает получателя, или если он уже существует - вернет его
Так-же в ответе уже есть и контактное лицо получателя
Создать получателя (Организация, Юр-лицо)
Класс CreateCounterPartyJuristicRequest
Результат - объект класса CounterPartyResponse
Для создания получателя нужно передать Код ЄДРПОУ организации получателя
Создать адрес получателя
Класс CreateAddressRequest
Результат - объект класса CounterPartyResponse
Создать накладную (ТТН):
Класс CreateExpressWaybillRequest
- Есть множество методов передачи данные, каждый метод начинается со слова
change
- Поддерживаемые методы соответствуют документации Новой Почты
Весь список методов:
Дополнительные функции:
- Добавить услугу наложенного платежа
$createRequest->cashBack(500);
- наложенный платеж - Добавить контроль оплат
$createRequest->enableCashControl(500)
- Используется если есть договор с Новой Почтой - Добавить габариты и вес посылки (места)
addOptionsSeat(float $width, float $height, float $length, float $weight = null)
Пример: 20 x 40 x 15 см, 3кг$createRequest->addOptionsSeat(20, 40, 15, 3)
- Получить количество мест
$createRequest->getOptionsSeatsCount()
Примеры запроса создания ТТН
Создание наложенного платежа
Так-же, функция $createRequest->change...()
возвращает свой экземпляр класса, по этому можно вызвать изменения вот так:
Трекинг ТТН
Получение данных о состоянии доставки
Класс: TrackingRequest
Вспомогательный класс NovaPoshta
Принимает api key и возвращает нужный класс запроса
Пример: что б постоянно не передавать api_key в каждый класс запроса, как тут
Можно воспользоваться классом NovaPoshta и запросить нужный класс Request
передав api_key один раз