Laravel 7 NovaPoshta API 2.0

Управление отправками NovaPoshta (novaposhta.ua) с помощью Laravel 7+ framework (Laravel).

Удобный пакет для отправки и проверки ТТН через сервис NovaPoshta.ua

ВНИМАНИЕ

// Пока нет нормального релиза (я не доделал и не оттестил все модели)
// используйте ветку `dev-master`
// В ней все самое последнее. Документацию стараюсь не затягивать

Laravel > 7, PHP >= 7.2.5

Минимальная версия Laravel 7.0, для более низкой версии нужно использовать guzzle/guzzle

Работает на Laravel 7+

Установка

Установите пакет через композер.

composer require daaner/novaposhta

Если вы НЕ используете autodiscover - добавьте сервис провайдер в конфигурационный файл config/app.php.

Daaner\NovaPoshta\NovaPoshtaServiceProvider::class,

Добавьте фасад NovaPoshta в массив в config/app.php:

'NovaPoshta' => Daaner\NovaPoshta\Facades\NovaPoshta::class,

Выполните публикацию конфига и локализационных файлов командой:

php artisan vendor:publish --provider="Daaner\NovaPoshta\NovaPoshtaServiceProvider"

Конфигураци

После публикации ресурсов поправьте файл config/novaposhta.php и заполните .env новыми полями.

Создайте аккаунт на сайте novaposhta.ua
Скопируйте Ключ API в настройках безопасности в разделе Мои ключи API и добавьте в соответствующий параметр в config/novaposhta.php либо в .env файл
point поддерживается только json (вряд ли добавится xml)
dev режим отладки запросов. Включает в лог каждый запрос на API Новой Почты (не оставляйте на продакшене)

Использование и API

setAPI($apiKey) - установка API ключа, отличного от значения по умолчанию

$cp = new Counterparty;
$cp->setAPI('391e241b2c********************e7');

getResponse($model, $calledMethod, $methodProperties, $auth = true) - кастомная отправка данных, если добавятся новые методы

use NovaPoshta;
$model = 'TrackingDocument'; //нужная модель
$calledMethod = 'getStatusDocuments'; //нужный метод
$methodProperties = [
  //данные по документации
];
$np = new NovaPoshta;
$data = $np->getResponse($model, $calledMethod, $methodProperties, $auth = true);

Поддержка моделей / методов

Хелперы (более детальные хелперы можно увидеть в документации к модели)

Хелперы вызываются до главного метода обращения:

$foo = new Common;
$foo->setLanguage('ru');
$list = $foo->getPaymentForms();

$bar = new Address;
$bar->setLimit(5)->setPage(2);
$cities = $bar->getCities();

setLanguage('ru') - переключает локализацию (только ru и ua), по умолчанию локализация украинская. Очень много моделей имеют в ответе дубляж на русском. В некоторых справочниках нет русской локализации.
setLimit(100) - лимит запроса записей
setPage(3) - пагинация при лимите