/b2b-api-php-laravel

Laravel package for a working with B2B API service

Primary LanguagePHPMIT LicenseMIT

Laravel

Расширенный клиент для работы с B2B API ресурса "avtocod"

Version Build Status StyleCI Coverage Code Quality Issues License Downloads count

При помощи данного пакета вы сможете интегрировать сервис по работе с B2B API ресурса "avtocod" в ваше Laravel >=5.4 приложение с помощью нескольких простых шагов.

Установка

Для установки данного пакета выполните в терминале следующую команду:

$ composer require avtocod/b2b-api-php-laravel "^2.3"

Для этого необходим установленный composer. Для его установки перейдите по данной ссылке.

Обратите внимание на то, что необходимо фиксировать мажорную версию устанавливаемого пакета.

Если вы используете Laravel версии 5.5 и выше, то сервис-провайдер данного пакета будет зарегистрирован автоматически. В противном случае вам необходимо самостоятельно зарегистрировать сервис-провайдер в секции providers файла ./config/app.php:

'providers' => [
    // ...
    Avtocod\B2BApiLaravel\B2BApiServiceProvider::class,
]

После чего "опубликуйте" необходимые для пакета ресурсы с помощью команды:

$ ./artisan vendor:publish --provider="Avtocod\B2BApiLaravel\B2BApiServiceProvider"

Данная команда создаст файл ./config/b2b-api-client.php с настройками "по умолчанию", которые вам следует переопределить на свои.

После чего откройте файл ./config/b2b-api-client.php и укажите в нем ваши реквизиты для подключения к сервису B2B API.

С новыми версиями пакета могут добавляться новые опции в конфигурационном файле. Пожалуйста, не забывайте время от времени проверять этот момент.

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

Данный пакет является пред-настроенной реализацией универсального пакета, который реализует весь функционал сервиса.

Для получения подробной информации о работе с сервисом и его документацией, пожалуйста, перейдите по следующей ссылке: avto-dev/b2b-api-php-laravel.

Поддержка и развитие

Если у вас возникли какие-либо проблемы по работе с данным пакетом, пожалуйста, создайте соответствующий issue в репозитории по этой ссылке.

Если вы способны самостоятельно реализовать тот функционал, что вам необходим - создайте PR с соответствующими изменениями. Крайне желательно сопровождать PR соответствующими тестами, фиксирующими работу ваших изменений. После проверки и принятия изменений будет опубликована новая минорная версия.

Лицензирование

Код данного пакета распространяется под лицензией MIT.