Download the PHP package lis-dev/nova-poshta-api-2 without Composer
On this page you can find all versions of the php package lis-dev/nova-poshta-api-2. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download lis-dev/nova-poshta-api-2
More information about lis-dev/nova-poshta-api-2
Files in lis-dev/nova-poshta-api-2
Package nova-poshta-api-2
Short Description PHP class for API 2.0 ukrainian delivery company "Nova Poshta"
License MIT
Homepage https://github.com/lis-dev/
Informations about the package nova-poshta-api-2
Документація українською мовою доступна за посиланням
Nova Poshta API 2.0
Класс предоставляет доступ к функциям API 2.0 службы доставки Новая Почта
Подготовка
Получение ключа API
Для использования API необходимо:
- зарегистрироваться на сайте Новой Почты
- На странице настроек в личном кабинете сгенерировать ключ для работы с API
После получения ключа API предоставляется возможность использовать все методы класса официальной из документации
Установка последней версии класса для работы с API
Git
Необходимо выполнить в командной строке
Composer
Необходимо создать файл composer.json
со следующим содержанием
и запустить из командной строки команду php composer.phar install
или php composer.phar update
Или выполнить в командной строке
Альтернативная установка
Необходимо скачать архив по ссылке
Форматы данных
Для входящих данных используются PHP массивы, ответ сервера может быть получен в формате:
- как PHP массив
- JSON
- XML
Использование
Подключение класса при установке через composer
Подключение класса при альтернативной установке
Создание экземпляра класса
Класс по умолчанию находится в namespace \LisDev\Delivery
. При создании экземпляра класса необходимо
или использовать Full Qualified Class Name:
или указать используемый namespace в секции use:
Более подробную информацию по работе с namespace можно получить на сайте документации php
Создание экземпляра класса (с расширенными параметрами)
Рекомендуется использовать, если необходимо получать данные на языке, отличном от русского, выбрасывать Exception при ошибке запроса, или при отсутствии установленной библиотеки curl на сервере
Получение информации о трек-номере
Получение сроков доставки
Получение стоимости доставки
Генерирование новой электронной накладной
Получение складов в определенном городе
Вызов произвольного метода
Реализованные методы для работы с моделями
Модель InternetDocument
- save
- update
- delete
- getDocumentPrice
- getDocumentDeliveryDate
- getDocumentList
- getDocument
- printDocument
- printMarkings
- documentsTracking
- newInternetDocument
- generateReport
Модель Counterparty
- save
- update
- delete
- cloneLoyaltyCounterpartySender
- getCounterparties
- getCounterpartyAddresses
- getCounterpartyContactPersons
- getCounterpartyByEDRPOU
- getCounterpartyOptions
Модель ContactPerson
- save
- update
- delete
Модель Address
- save
- update
- delete
- getCities
- getStreet
- getWarehouses
- getAreas
- findNearestWarehouse
Модель Common
- getTypesOfCounterparties
- getBackwardDeliveryCargoTypes
- getCargoDescriptionList
- getCargoTypes
- getDocumentStatuses
- getOwnershipFormsList
- getPalletsList
- getPaymentForms
- getTimeIntervals
- getServiceTypes
- getTiresWheelsList
- getTraysList
- getTypesOfPayers
- getTypesOfPayersForRedelivery
Тесты
Актуальные тесты и примеры использования класса находятся в файле tests/NovaPoshtaApi2Test.php
Для запуска тестов локально необходимо выполнить в командной строке